aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrick Lehmann <Patrick.Lehmann@plc2.de>2021-01-04 16:13:12 +0100
committertgingold <tgingold@users.noreply.github.com>2021-01-05 18:50:44 +0100
commit33cf590ce60c5d76e476a4f5438f859395717796 (patch)
tree51f77f7afdbf5bfccda90ee3b4382719372cc4d5
parent29755634957933656e0e318a64bd5806b52cbf1c (diff)
downloadghdl-33cf590ce60c5d76e476a4f5438f859395717796.tar.gz
ghdl-33cf590ce60c5d76e476a4f5438f859395717796.tar.bz2
ghdl-33cf590ce60c5d76e476a4f5438f859395717796.zip
Updated prolog for Sphinx (global include per ReST file).
-rw-r--r--.gitignore2
-rw-r--r--doc/prolog.inc11
2 files changed, 11 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
index 2a290d646..e7c15aa0f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -55,6 +55,7 @@ __pycache__/
# Python installation packages
dist/
+pyGHDL.egg-info/
# Coverage.py
.coverage
@@ -63,6 +64,7 @@ coverage.xml
# Sphinx
doc/_build/
+doc/_theme/
doc/pyGHDL/**/*.*
!doc/pyGHDL/index.rst
diff --git a/doc/prolog.inc b/doc/prolog.inc
index 0f74e33fe..7297d9939 100644
--- a/doc/prolog.inc
+++ b/doc/prolog.inc
@@ -1,7 +1,14 @@
-.. # preload commonly known graphical characters like (c)
+.. # 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 kine break for HTML
+.. # define a hard line break for HTML
.. |br| raw:: html
<br />
+
+.. |hr| raw:: html
+
+ <hr />