From cab44a1f8580880e59e9ccfd7d98e71fa111b16a Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Sat, 4 Mar 2017 21:13:55 +0100 Subject: Fixed more syntax problems. --- doc/building/Building.rst | 6 +++--- doc/changelog/Roadmap.rst | 6 +++--- doc/conf.py | 6 ++++-- 3 files changed, 10 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/building/Building.rst b/doc/building/Building.rst index 92e2de96f..e46b9c0b7 100644 --- a/doc/building/Building.rst +++ b/doc/building/Building.rst @@ -12,12 +12,12 @@ GHDL currently supports three supported different backends (code generators): `m | | - very quick analysis | - simulation is slower | | | - can handle very large designs | | +------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------+ -| GCC | - generated code is faster (particularly with :samp:`-O` or :samp:`-O2`) | - analysis can take time (particularly for large units) | +| GCC | - generated code is faster (particularly with :samp:`-O` or :samp:`-O2`) | - analysis can take time (particularly for large units) | | | - generated code can be debugged (with :samp:`-g`) | - build is more complex | | | - ported to many platforms (:samp:`x86`, :samp:`x86_64`, :samp:`powerpc`, :samp:`sparc`) | | +------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------+ -| LLVM | - Same as GCC | Coverage, :samp:`gcov`, is unique to GCC | -| | - Easier to build than GCC | | +| LLVM | - Same as GCC | Coverage, :samp:`gcov`, is unique to GCC | +| | - Easier to build than GCC | | +------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------+ .. HINT:: The output of both GCC and LLVM is an executable file, but `mcode` does not generate any. Therefore, if using GCC/LLVM, the call with argument :samp:`-r` can be replaced with direct execution of the binary. See section :ref:`USING:QuickStart`. diff --git a/doc/changelog/Roadmap.rst b/doc/changelog/Roadmap.rst index 93589170e..5358d3a57 100644 --- a/doc/changelog/Roadmap.rst +++ b/doc/changelog/Roadmap.rst @@ -1,7 +1,7 @@ .. _CHANGE:Roadmap: -Roadmap | Future improvements -############ +Roadmap | Future Improvements +############################# I have several axes for `GHDL` improvements: @@ -14,7 +14,7 @@ I have several axes for `GHDL` improvements: * VITAL acceleration TODOs -================= +===== - RTD builds fail if EPUB is activated. - Convert VendorPrimitives Markdown to RST diff --git a/doc/conf.py b/doc/conf.py index d7763c490..49031a031 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -148,10 +148,12 @@ todo_include_todos = True todo_link_only = True # reST settings +prologPath = "prolog.inc" try: - with open("prolog.inc", "r") as prologFile: + with open(prologPath, "r") as prologFile: rst_prolog = prologFile.read() except: + print("[ERROR:] File '{0!s}' nor found.".format(prologPath)) rst_prolog = "" # -- Options for HTML output ---------------------------------------------- @@ -346,7 +348,7 @@ texinfo_documents = [ # Sphinx.Ext.InterSphinx # ============================================================================== intersphinx_mapping = { - 'python': ('https://docs.python.org/3.5/', None), + 'python': ('https://docs.python.org/3.6/', None), 'poc': ('http://poc-library.readthedocs.io/en/release', None), # 'ghdl': ('http://ghdl.readthedocs.io/en/latest', None) } -- cgit v1.2.3