Hardware
/
litex
mirror of https://github.com/enjoy-digital/litex.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc/conf.py: no modindex, no numpydoc warnings 

* do not generate boring modindex for html and latex outputs
* numpydoc_show_class_members=False, to skip undocumented methods
  https://github.com/phn/pytpm/issues/3#issuecomment-12133978
This commit is contained in:
Robert Jördens 2013-11-28 23:35:34 -07:00 committed by Sebastien Bourdeauducq
parent 73db4944f1
commit a836cbb44e
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/conf.py
View File

@ -90,8 +90,9 @@ exclude_patterns = ['_build']
pygments_style = 'sphinx' pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
#modindex_common_prefix = [] modindex_common_prefix = ['migen.', 'mibuild.']
numpydoc_show_class_members = False
# -- Options for HTML output --------------------------------------------------- # -- Options for HTML output ---------------------------------------------------
@ -172,6 +173,7 @@ html_static_path = ['_static']
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'Migendoc' htmlhelp_basename = 'Migendoc'
html_use_modindex = False
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
@ -211,6 +213,7 @@ latex_preamble = '\setcounter{tocdepth}{3}'
# If false, no module index is generated. # If false, no module index is generated.
#latex_domain_indices = True #latex_domain_indices = True
latex_use_modindex = False
# -- Options for manual page output -------------------------------------------- # -- Options for manual page output --------------------------------------------