WIP

faucetsdn · Dec 2, 2017 · af00a7e · af00a7e
1 parent 7db3533
commit af00a7e
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 14 deletions.
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/README.rst b/docs/README.rst
@@ -0,0 +1,12 @@
+Viewing documentation
+=====================
+
+Docs are viewable on `readthedocs <https://faucet.readthedocs.io>`_.
+
+Building documentation
+======================
+
+.. code:: bash
+
+  sudo pip3 install -r requirements.txt
+  make html
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,6 @@
 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 ------------------------------------------------
@@ -159,6 +158,3 @@
      author, 'faucet', '',
      'Miscellaneous'),
 ]
-
-
-
diff --git a/docs/self_signed_certs.md b/docs/self_signed_certs.md