adding noxfile for docs and some dependencies. Test1

GuillermoFidalgo · Apr 23, 2024 · 3d41cff · 3d41cff
1 parent 94a1f6c
commit 3d41cff
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -61,7 +61,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: docs/build
+          path: docs/build/html
           name: github-pages
 
 

diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -7,7 +7,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath("../src"))
+sys.path.insert(0, os.path.abspath("../../src"))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

diff --git a/docs/document.rst → docs/source/document.rst b/docs/document.rst → docs/source/document.rst
diff --git a/noxfile.py b/noxfile.py
@@ -51,4 +51,10 @@ def docs(session: nox.Session) -> None:
     session.install(".[docs]")
     session.install("sphinx_rtd_theme")
     session.chdir("docs")
-    session.run("sphinx-build", "-M", "html", ".", "build")
+    session.run("sphinx-build", "-M", "html", "source/", "build")
+
+@nox.session
+def serve(session: nox.Session) -> None:
+    docs(session)
+    print("Launching docs at http://localhost:8000/ - use Ctrl-C to quit")
+    session.run("python", "-m", "http.server", "8000", "-d", "build/html")