From: Robert Jördens <jordens@gmail.com>
Date: Fri, 29 Nov 2013 06:35:34 +0000 (-0700)
Subject: doc/conf.py: no modindex, no numpydoc warnings
X-Git-Tag: 24jan2021_ls180~2099^2~427
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=a836cbb44ea835a011d8ed3ba98654f98423575f;p=litex.git

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
---

diff --git a/doc/conf.py b/doc/conf.py
index 601e717d..773d7cf4 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -90,8 +90,9 @@ exclude_patterns = ['_build']
 pygments_style = 'sphinx'
 
 # 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 ---------------------------------------------------
 
@@ -172,6 +173,7 @@ html_static_path = ['_static']
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Migendoc'
 
+html_use_modindex = False
 
 # -- Options for LaTeX output --------------------------------------------------
 
@@ -211,6 +213,7 @@ latex_preamble = '\setcounter{tocdepth}{3}'
 # If false, no module index is generated.
 #latex_domain_indices = True
 
+latex_use_modindex = False
 
 # -- Options for manual page output --------------------------------------------