diff options
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 266 |
1 files changed, 37 insertions, 229 deletions
diff --git a/doc/conf.py b/doc/conf.py index ef047cb96..e28ce3e16 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,18 +1,6 @@ # -*- coding: utf-8 -*- -# -# GHDL documentation build configuration file, created by -# sphinx-quickstart on Fri Nov 20 20:33:03 2015. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os, shlex, re, subprocess + +import sys, re from os.path import abspath, join # If extensions (or modules to document with autodoc) are in another directory, @@ -25,40 +13,29 @@ sys.path.insert(0, abspath('.')) # If your documentation needs a minimal Sphinx version, state it here. needs_sphinx = '1.5' -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ -# Standard Sphinx extensions - 'recommonmark', - 'sphinx.ext.extlinks', - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.graphviz', - 'sphinx.ext.mathjax', - 'sphinx.ext.ifconfig', - 'sphinx.ext.viewcode', - # 'sphinx.ext.githubpages', -# SphinxContrib extensions - # 'sphinxcontrib.textstyle', - # 'sphinxcontrib.spelling', -# Other + # Standard Sphinx extensions + 'recommonmark', + 'sphinx.ext.extlinks', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.graphviz', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + # Other 'exec', ] -# Add any paths that contain templates here, relative to this directory. templates_path = ['_templates', '_themes'] # The suffix(es) of source filenames. source_suffix = { '.rst': 'restructuredtext', - #'.txt': 'markdown', + # '.txt': 'markdown', '.md': 'markdown', } -# The encoding of source files. -#source_encoding = 'utf-8-sig' - # The master toctree document. master_doc = 'index' @@ -72,16 +49,16 @@ author = u'Tristan Gingold and contributors' # built documents. try: - with open('../configure') as verin: - for line in verin: - line = re.findall(r'ghdl_version=\"([0-9].+)\"', line) - if line: - version=line[0] - break + with open('../configure') as verin: + for line in verin: + line = re.findall(r'ghdl_version=\"([0-9].+)\"', line) + if line: + version = line[0] + break except Exception as e: - print('cannot extract version: %s' % e) - version = "latest" - pass + print('cannot extract version: %s' % e) + version = "latest" + pass release = version # The full version, including alpha/beta/rc tags. @@ -91,40 +68,13 @@ release = version # The full version, including alpha/beta/rc tags. # Usually you set "language" from the command line for these cases. language = None -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True todo_link_only = True @@ -132,19 +82,17 @@ todo_link_only = True # reST settings prologPath = "prolog.inc" try: - with open(prologPath, "r") as prologFile: - rst_prolog = prologFile.read() + with open(prologPath, "r") as prologFile: + rst_prolog = prologFile.read() except Exception as ex: - print("[ERROR:] While reading '{0!s}'.".format(prologPath)) - print(ex) - rst_prolog = "" + print("[ERROR:] While reading '{0!s}'.".format(prologPath)) + print(ex) + 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" + # Override default css to get a larger width for ReadTheDoc build html_context = { 'css_files': [ @@ -154,190 +102,50 @@ html_context = { ], } -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' - # Output file base name for HTML help builder. htmlhelp_basename = 'GHDLdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -'papersize': 'a4paper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', + 'papersize': 'a4paper', } # Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). +# (source start file, target name, title, author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'GHDL.tex', u'GHDL Documentation', - u'Tristan Gingold', 'manual'), + (master_doc, 'GHDL.tex', u'GHDL Documentation', author, 'manual'), ] -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'ghdl', u'GHDL Documentation', - [author], 1) + (master_doc, 'ghdl', u'GHDL Documentation', [author], 1) ] -# If true, show URL addresses after external links. -#man_show_urls = False - - # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) +# (source start file, target name, title, author, dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'GHDL', u'GHDL Documentation', - author, 'GHDL', 'VHDL simulator.', - 'Miscellaneous'), + (master_doc, 'GHDL', u'GHDL Documentation', author, 'GHDL', 'VHDL simulator.', 'Miscellaneous'), ] -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# -- Sphinx.Ext.InterSphinx ----------------------------------------------- -# ============================================================================== -# Sphinx.Ext.InterSphinx -# ============================================================================== intersphinx_mapping = { 'python': ('https://docs.python.org/3.6/', None), - 'poc': ('https://poc-library.readthedocs.io/en/release', None), -# 'ghdl': ('http://ghdl.readthedocs.io/en/latest', None) + 'poc': ('https://poc-library.readthedocs.io/en/release', None) } -# ============================================================================== -# Sphinx.Ext.ExtLinks -# ============================================================================== +# -- Sphinx.Ext.ExtLinks -------------------------------------------------- extlinks = { 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), 'ghdlsharp': ('https://github.com/ghdl/ghdl/issues/%s', '#'), |