WIP.

docs2/conf.py

@@ -20,6 +20,8 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+autodoc_mock_imports = ["ryu", "networkx", "prometheus_client", "influxdb", "couchdb"]
+autodoc_default_flags = ["members", "undoc-members", "show-inheritance"]
 
 # -- General configuration ------------------------------------------------
 
@@ -49,18 +51,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'faucet'
-copyright = u'2017, faucet developers'
-author = u'faucet developers'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = u'1.6.7'
-# The full version, including alpha/beta/rc tags.
-release = u'1.6.7'
+copyright = u'2017, Faucet Developers'
+author = u'Faucet Developers'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -142,7 +134,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'faucet.tex', u'faucet Documentation',
+    (master_doc, 'faucet.tex', u'Faucet Documentation',
      u'faucet developers', 'manual'),
 ]
 
@@ -152,7 +144,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'faucet', u'faucet Documentation',
+    (master_doc, 'faucet', u'Faucet Documentation',
      [author], 1)
 ]
 
@@ -163,7 +155,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'faucet', u'faucet Documentation',
+    (master_doc, 'faucet', u'Faucet Documentation',
      author, 'faucet', 'One line description of project.',
      'Miscellaneous'),
 ]

docs2/index.rst

@@ -10,6 +10,7 @@ Welcome to faucet's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   source/index
 
 
 Indices and tables

setup.cfg

@@ -37,3 +37,9 @@ data_files =
 console_scripts =
     check_faucet_config = faucet.check_faucet_config:main
     fctl = faucet.fctl:main
+
+[build_sphinx]
+project = 'faucet'
+source-dir = docs2
+build-dir  = docs2/_build
+all_files  = 1