Reformat library reference (etingof#19)

* refactor and update api docs * examples added to docs
inexio · Nov 12, 2017 · a602b43 · a602b43
1 parent d608898
commit a602b43
Show file tree

Hide file tree

Showing 47 changed files with 594 additions and 294 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -2,7 +2,7 @@
 Revision 0.2.2, XX-11-2017
 --------------------------
 
-No changes yet
+- Library documentation refactored and updated
 
 Revision 0.2.1, 11-11-2017
 --------------------------

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -315,8 +315,8 @@
 autoclass_content = 'both'
 
 # Napoleon settings
-napoleon_google_docstring = False
-napoleon_numpy_docstring = True
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
 napoleon_include_private_with_doc = False
 napoleon_include_special_with_doc = True
 napoleon_use_admonition_for_examples = False

diff --git a/docs/source/developer-documentation.rst b/docs/source/developer-documentation.rst
diff --git a/docs/source/documentation.rst b/docs/source/documentation.rst
@@ -1,6 +1,6 @@
 
-Documentation
-=============
+PySMI documentation
+===================
 
 PySMI library is highly modular. The top-level component is called
 *compiler* and it acts as main user-facing object. Most of other
@@ -41,5 +41,5 @@ chosen and configured to compiler.
 .. toctree::
    :maxdepth: 2
 
-   /user-perspective
-   /developer-documentation
+   /mibdump
+   /library-reference
diff --git a/docs/source/examples/always-borrow-precompiled-pysnmp-files.rst b/docs/source/examples/always-borrow-precompiled-pysnmp-files.rst
@@ -0,0 +1,11 @@
+
+.. include:: /../../examples/always-borrow-precompiled-pysnmp-files.py
+   :start-after: """
+   :end-before: """#
+
+.. literalinclude:: /../../examples/always-borrow-precompiled-pysnmp-files.py
+   :start-after: """#
+   :language: python
+
+:download:`Download</../../examples/always-borrow-precompiled-pysnmp-files.py>` script.
+
diff --git a/docs/source/examples/borrow-precompiled-pysnmp-files-on-failure.rst b/docs/source/examples/borrow-precompiled-pysnmp-files-on-failure.rst
@@ -0,0 +1,11 @@
+
+.. include:: /../../examples/borrow-precompiled-pysnmp-files-on-failure.py
+   :start-after: """
+   :end-before: """#
+
+.. literalinclude:: /../../examples/borrow-precompiled-pysnmp-files-on-failure.py
+   :start-after: """#
+   :language: python
+
+:download:`Download</../../examples/borrow-precompiled-pysnmp-files-on-failure.py>` script.
+
diff --git a/docs/source/examples/compile-smistar-mibs-into-pysnmp-files-if-needed.rst b/docs/source/examples/compile-smistar-mibs-into-pysnmp-files-if-needed.rst
@@ -0,0 +1,11 @@
+
+.. include:: /../../examples/compile-smistar-mibs-into-pysnmp-files-if-needed.py
+   :start-after: """
+   :end-before: """#
+
+.. literalinclude:: /../../examples/compile-smistar-mibs-into-pysnmp-files-if-needed.py
+   :start-after: """#
+   :language: python
+
+:download:`Download</../../examples/compile-smistar-mibs-into-pysnmp-files-if-needed.py>` script.
+
diff --git a/docs/source/examples/compile-smiv2-mibs-from-text-into-pysnmp-code.rst b/docs/source/examples/compile-smiv2-mibs-from-text-into-pysnmp-code.rst
@@ -0,0 +1,11 @@
+
+.. include:: /../../examples/compile-smiv2-mibs-from-text-into-pysnmp-code.py
+   :start-after: """
+   :end-before: """#
+
+.. literalinclude:: /../../examples/compile-smiv2-mibs-from-text-into-pysnmp-code.py
+   :start-after: """#
+   :language: python
+
+:download:`Download</../../examples/compile-smiv2-mibs-from-text-into-pysnmp-code.py>` script.
+
diff --git a/docs/source/examples/download-and-compile-smistar-mibs-into-json.rst b/docs/source/examples/download-and-compile-smistar-mibs-into-json.rst
@@ -0,0 +1,11 @@
+
+.. include:: /../../examples/download-and-compile-smistar-mibs-into-json.py
+   :start-after: """
+   :end-before: """#
+
+.. literalinclude:: /../../examples/download-and-compile-smistar-mibs-into-json.py
+   :start-after: """#
+   :language: python
+
+:download:`Download</../../examples/download-and-compile-smistar-mibs-into-json.py>` script.
+
diff --git a/docs/source/examples/download-and-compile-smistar-mibs-into-pysnmp-files.rst b/docs/source/examples/download-and-compile-smistar-mibs-into-pysnmp-files.rst
@@ -0,0 +1,11 @@
+
+.. include:: /../../examples/download-and-compile-smistar-mibs-into-pysnmp-files.py
+   :start-after: """
+   :end-before: """#
+
+.. literalinclude:: /../../examples/download-and-compile-smistar-mibs-into-pysnmp-files.py
+   :start-after: """#
+   :language: python
+
+:download:`Download</../../examples/download-and-compile-smistar-mibs-into-pysnmp-files.py>` script.
+