Hardware
/
f4pga
mirror of https://github.com/chipsalliance/f4pga.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add missing extensions and exclude patterns 

This commit adds missing sphinx extensions and
additional exclude patterns to reduce the number of warnings

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
This commit is contained in:
Robert Winkler 2020-02-24 15:33:13 +01:00
parent 453abf8e1f
commit d9ff9bf28d
2 changed files with 25 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
requirements.txt
View File

@ -1,6 +1,9 @@
Sphinx==2.4.0 Sphinx==2.4.0
git+http://github.com/SymbiFlow/sphinx_materialdesign_theme.git@master#egg=sphinx_symbiflow_theme git+http://github.com/SymbiFlow/sphinx_materialdesign_theme.git@master#egg=sphinx_symbiflow_theme
sphinx-markdown-tables sphinx-markdown-tables==0.0.12
breathe==4.13.1 breathe==4.13.1
symbolator==1.0.2 symbolator==1.0.2
sphinxcontrib-images==0.9.1 sphinxcontrib-images==0.9.1
recommonmark==0.6.0
sphinxcontrib-bibtex==0.4.2
sphinxcontrib-domaintools==0.2

24
source/conf.py
View File

@ -20,14 +20,23 @@ import sys, os
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.6' needs_sphinx = '1.6'
# 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 # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.autodoc',
'sphinx.ext.imgmath', # breathe 'sphinx.ext.imgmath', # breathe
'breathe', 'breathe',
'symbolator_sphinx', 'symbolator_sphinx',
'sphinxcontrib.images' 'sphinxcontrib.images',
'sphinxcontrib.bibtex',
'sdcdomain',
'archdomain',
'rrgraphdomain',
'recommonmark'
] ]
numfig = True numfig = True
@ -36,7 +45,7 @@ numfig = True
templates_path = ['_templates'] templates_path = ['_templates']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = ['.rst', '.md']
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' #source_encoding = 'utf-8-sig'
@ -71,7 +80,16 @@ today_fmt = '%Y-%m-%d'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = [] exclude_patterns = [
'symbiflow-arch-defs/*',
'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/**',
]
# The reST default role (used for this markup: `text`) to use for all documents. # The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None #default_role = None