doc/conf.py: no modindex, no numpydoc warnings
authorRobert Jördens <jordens@gmail.com>
Fri, 29 Nov 2013 06:35:34 +0000 (23:35 -0700)
committerSebastien Bourdeauducq <sebastien@milkymist.org>
Fri, 29 Nov 2013 21:31:59 +0000 (22:31 +0100)
* 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

doc/conf.py

index 601e717dd75d5078a14b715d1c3471040d0e355b..773d7cf40cfa4607368929b5b268a8bd3f3ebcb8 100644 (file)
@@ -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 --------------------------------------------