diff --git a/source/conf.py b/source/conf.py index 4d06500..c53ddea 100644 --- a/source/conf.py +++ b/source/conf.py @@ -1,127 +1,53 @@ # -*- coding: utf-8 -*- # -# 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. +# Updated documentation of the configuration options is available at +# https://www.sphinx-doc.org/en/master/usage/configuration.html import sys, os -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ----------------------------------------------------- -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '3.0.4' - -# For VTR documentation support -sys.path.append(os.path.abspath('./vtr-verilog-to-routing/doc/_exts')) - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [ - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.autodoc', - 'sphinx.ext.imgmath', # breathe - 'breathe', - 'symbolator_sphinx', - 'sphinxcontrib.images', - 'sphinxcontrib.bibtex', - 'sdcdomain', - 'archdomain', - 'rrgraphdomain', - 'recommonmark', - 'sphinx_verilog_domain' -] - -numfig = True - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = ['.rst', '.md'] - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. project = u'SymbiFlow' basic_filename = u'symbiflow-docs' authors = u'SymbiFlow' copyright = authors + u', 2019' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. version = '' -# The full version, including alpha/beta/rc tags. -release = '' +release = '' # The full version, including alpha/beta/rc tags. -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#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 = '%Y-%m-%d' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [ - 'symbiflow-arch-defs/third_party/**', - 'prjtrellis/third_party/**', - 'prjxray/third_party/**', - 'prjxray/docs/db_dev_process/fuzzers/index/**', - 'prjxray/docs/db_dev_process/minitests/index/**', - 'vtr-verilog-to-routing/libs/EXTERNAL/**.md', - 'vtr-verilog-to-routing/.github/**', +extensions = [ + 'sphinx.ext.intersphinx', + 'sphinx_verilog_domain' ] -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +numfig = True -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +templates_path = ['_templates'] -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True +source_suffix = ['.rst', '.md'] -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False +master_doc = 'index' + +today_fmt = '%Y-%m-%d' + +exclude_patterns = [] -# The name of the Pygments (syntax highlighting) style to use. pygments_style = 'default' -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +rst_prolog = """ +.. role:: raw-latex(raw) + :format: latex + +.. role:: raw-html(raw) + :format: html +""" # -- 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 = "sphinx_symbiflow_theme" -# 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 = { # Specify a list of menu in Header. # Tuples forms: @@ -170,117 +96,21 @@ html_theme_options = { 'show_footer': True } -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = None - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". html_title = project -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. html_last_updated_fmt = today_fmt -# 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 = False -# 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 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 - -# Output file base name for HTML help builder. htmlhelp_basename = basic_filename - # -- Options for LaTeX output -------------------------------------------------- -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', basic_filename+'.tex', project, authors, '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 - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# 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 = [ - ('index', basic_filename, project, - [authors], 1) -] - latex_elements = { 'papersize': 'a4paper', 'pointsize': '11pt', @@ -307,50 +137,12 @@ latex_elements = { ''' } -rst_prolog = """ -.. role:: raw-latex(raw) - :format: latex +# -- Options for manual page output -------------------------------------------- -.. role:: raw-html(raw) - :format: html -""" - -### BREATHE ### - -from pathlib import Path -import subprocess - -# For building doxygen only on Read the Docs see: -# https://breathe.readthedocs.io/en/latest/readthedocs.html - -def doxygen_generate(log_file=None): - doxygen_cmake_build_dir = Path('../doxygen/build') - if not doxygen_cmake_build_dir.exists(): - doxygen_cmake_build_dir.mkdir(parents=True, exist_ok=True) - cmd = "cd " + str(doxygen_cmake_build_dir) + "&& cmake .. && make" - else: - cmd = "cd " + str(doxygen_cmake_build_dir) + "&& make" - - subprocess.call(cmd, shell=True, stderr=log_file, stdout=log_file) - -doxygen_generate() - -breathe_projects = { - "prjxray" : "../build/doxygen/prjxray/xml", -} - -### SYMBOLATOR ### - -symbolator_cmd_args = ['--transparent'] -symbolator_output_format = 'svg' - -### PRJXRAY FUZZERS AND MINITESTS LINKS - -def prjxray_fuzzers_and_minitests_links(): - cmd = "cd prjxray/docs && make links" - subprocess.call(cmd, shell=True) - -prjxray_fuzzers_and_minitests_links() +man_pages = [ + ('index', basic_filename, project, + [authors], 1) +] # -- Sphinx.Ext.InterSphinx --------------------------------------------------------------------------------------------