docs/conf.py: Active sphinx_selective_exclude extensions.

pfalcon · pfalcon · commit 91031b60dc97 · 2016-06-12T01:18:13.000+03:00
For modindex_exclude extension, per-port module excludes are also added.
With these changes, it's possible to generate docs for a particular port
devoid of any superfluous and unrelated content, including in indexes and
full-text search - with small caveat: when generating PDF docs after HTML,
or vice-versa cached internal doctree representation (build/*/doctrees/)
must be removed first.
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,7 @@
 # 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('.'))
+sys.path.insert(0, os.path.abspath('.'))
 
 # Work out the port to generate the docs for
 from collections import OrderedDict
@@ -71,6 +71,9 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
+    'sphinx_selective_exclude.modindex_exclude',
+    'sphinx_selective_exclude.eager_only',
+    'sphinx_selective_exclude.search_auto_exclude',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -316,6 +319,20 @@
 
 # Append the other ports' specific folders/files to the exclude pattern
 exclude_patterns.extend([port + '*' for port in ports if port != micropy_port])
-# Exclude pyb module if the port is the WiPy
-if micropy_port == 'wipy':
-    exclude_patterns.append('library/pyb*')
+
+modules_port_specific = {
+    'pyboard': ['pyb'],
+    'wipy': ['wipy'],
+    'esp8266': ['esp'],
+}
+
+modindex_exclude = []
+
+for p, l in modules_port_specific.items():
+    if p != micropy_port:
+        modindex_exclude += l
+
+# Exclude extra modules per port
+modindex_exclude += {
+    'esp8266': ['cmath', 'select'],
+}.get(micropy_port, [])
