Merge pull request #155 from BjornFJohansson/issue_154

closes #154

README.md

@@ -255,6 +255,19 @@ or by `pip install scipy matplotlib pillow pyparsing requests cai2 pyqt5`
 3. Add the necessary tests in `tests/`.
 4. Run the tests from the root directory with `python run_test.py`.
 
+#### Building the documentation locally
+
+Below the commands to run a local sphinx server that auto-updated when files are changed.
+
+```
+# Install docs dependency group
+poetry install --with docs
+
+# Start the sphinx server to see docs live by default at http://127.0.0.1:8000/
+sphinx-autobuild --watch src/ docs docs/_build/html
+
+```
+
 ## Releases
 
 See the [releases](https://github.com/BjornFJohansson/pydna/releases) for changes and releases.

docs/conf.py

@@ -30,6 +30,7 @@
     "sphinx.ext.autosummary",
     "numpydoc",
     "sphinx.ext.intersphinx",
+    "sphinx_rtd_theme",
 ]
 
 # Add mappings https://kev.inburke.com/kevin/sphinx-interlinks
@@ -46,7 +47,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
 
 texinfo_documents = [