diff options
| author | Patrick Lehmann <Patrick.Lehmann@tu-dresden.de> | 2017-03-04 18:47:51 +0100 |
|---|---|---|
| committer | tgingold <tgingold@users.noreply.github.com> | 2017-12-10 12:02:05 +0100 |
| commit | 4b041636ecc3581afc4839dad03f464d0da14cdc (patch) | |
| tree | f5da14f3128a8777c4934a20c6c62dffeb77d73f | |
| parent | 7b2b91900e8217fd75fcc755f14c5f098662f1f8 (diff) | |
| download | ghdl-4b041636ecc3581afc4839dad03f464d0da14cdc.tar.gz ghdl-4b041636ecc3581afc4839dad03f464d0da14cdc.tar.bz2 ghdl-4b041636ecc3581afc4839dad03f464d0da14cdc.zip | |
Read `rst_prolog` content from an external file.
| -rw-r--r-- | doc/conf.py | 14 | ||||
| -rw-r--r-- | doc/prolog.inc | 7 |
2 files changed, 13 insertions, 8 deletions
diff --git a/doc/conf.py b/doc/conf.py index 05d81f264..d7763c490 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -148,20 +148,18 @@ todo_include_todos = True todo_link_only = True # reST settings - -rst_prolog = """\ -.. include:: <isonum.txt> -.. |br| raw:: html - - <br /> -""" +try: + with open("prolog.inc", "r") as prologFile: + rst_prolog = prologFile.read() +except: + rst_prolog = "" # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. #html_theme = 'alabaster' -#html_theme = "sphinx_rtd_theme" +html_theme = "sphinx_rtd_theme" # Override default css to get a larger width for ReadTheDoc build html_context = { 'css_files': [ diff --git a/doc/prolog.inc b/doc/prolog.inc new file mode 100644 index 000000000..94490f67c --- /dev/null +++ b/doc/prolog.inc @@ -0,0 +1,7 @@ +.. # preload commonly known graphical characters like © +.. include:: <isonum.txt> + +.. # define a hard kine break for HTML +.. |br| raw:: html + + <br /> |