Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update conf.py #41

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,19 @@

numfig = True

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "manni"

# -- Restructured Text settings ----------------------------------------------------------------------------------------
prologPath = "prolog.inc"
try:
with open(prologPath, "r") as prologFile:
rst_prolog = prologFile.read()
except Exception as ex:
print(f"[ERROR:] While reading '{prologPath}'.")
print(ex)
rst_prolog = ""

# -- Options for HTML output -------------------------------------------------------------------------------------------

html_context = {}
Expand Down
63 changes: 63 additions & 0 deletions doc/prolog.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
.. # Load pre-defined aliases and graphical characters like © from docutils
# <file> is used to denote the special path
# <Python>\Lib\site-packages\docutils\parsers\rst\include
.. include:: <isonum.txt>
.. include:: <mmlalias.txt>

.. # define a hard line break for HTML
.. |br| raw:: html

<br />

.. # define horizontal line for HTML
.. |hr| raw:: html

<hr />

.. # define additional CSS based styles and ReST roles for HTML
.. raw:: html

<style type="text/css">
span.bolditalic {font-weight: bold; font-style: italic; }
span.underline {text-decoration: underline; }
span.strike {text-decoration: line-through; }
span.xlarge {font-size: x-large; }
span.colorred {color: #CC0000; }
span.colorgreen {color: #009933; }
span.colorblue {color: #0066FF; }
span.colorpurple {color: #9900CC; }
</style>

.. role:: bolditalic
:class: bolditalic

.. role:: underline
:class: underline

.. role:: strike
:class: strike

.. role:: xlarge
:class: xlarge

.. role:: red
:class: colorred
.. role:: green
:class: colorgreen
.. role:: blue
:class: colorblue
.. role:: purple
:class: colorpurple

.. role:: deletion
:class: colorred strike
.. role:: addition
:class: colorgreen

.. role:: pycode(code)
:language: python
:class: highlight

.. role:: vhdlcode(code)
:language: vhdl
:class: highlight