[docs] Updated Sphinx configuration #56

Use the shared OpenWISP theme and package metadata so published
documentation stays consistent with other OpenWISP projects.
Adding the project root to the Sphinx path keeps local documentation
builds working without an editable installation.

Related to #56

Author: nemesifier

docs/source/conf.py

@@ -12,13 +12,16 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import datetime
 import os
 import sys
 
 # 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("../.."))
+
+from netengine import VERSION, get_version
 
 # -- General configuration ------------------------------------------------
 
@@ -28,7 +31,11 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "openwisp.sphinx.theme",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -44,20 +51,21 @@
 
 # General information about the project.
 project = "netengine"
-copyright = "OpenWISP.org"
+copyright = f"{datetime.date.today().year}, OpenWISP.org"
+author = "Federico Capoano"
 
 # 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 = "0.1"
+version = f"{VERSION[0]}.{VERSION[1]}"
 # The full version, including alpha/beta/rc tags.
-release = "0.1"
+release = get_version()
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-# language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -98,7 +106,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "default"
+html_theme = "openwisp-sphinx-theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -198,7 +206,7 @@
         "index",
         "netengine.tex",
         "netengine Documentation",
-        "Alessandro Bucciarelli, Federico Capoano",
+        author,
         "manual",
     ),
 ]
@@ -233,7 +241,7 @@
         "index",
         "netengine",
         "netengine Documentation",
-        ["Alessandro Bucciarelli, Federico Capoano"],
+        [author],
         1,
     )
 ]
@@ -252,9 +260,9 @@
         "index",
         "netengine",
         "netengine Documentation",
-        "Alessandro Bucciarelli, Federico Capoano",
+        author,
         "netengine",
-        "One line description of project.",
+        "Abstraction layer for extracting information from network devices.",
         "Miscellaneous",
     ),
 ]

requirements-test.txt

@@ -2,4 +2,5 @@ nose2[coverage_plugin]>=0.16.0
 coveralls
 jsonschema~=4.26.0
 sphinx
+openwisp-sphinx-theme~=1.0.2
 openwisp-utils[qa] @ https://github.com/openwisp/openwisp-utils/archive/refs/heads/1.3.tar.gz