Merge pull request #406 from Plant-Tracer/dev-sphynx

Try again to get sphynx to work
Plant-Tracer · May 19, 2024 · c3d503e · c3d503e
2 parents 1eca226 + 8da6442
commit c3d503e
Show file tree

Hide file tree

Showing 48 changed files with 39 additions and 7 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -17,7 +17,7 @@ jobs:
           pip install sphinx sphinx_rtd_theme myst_parser
       - name: Sphinx build
         run: |
-          sphinx-build doc _build
+          sphinx-build docs _build
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

diff --git a/doc/INSTALL.md → docs/Installation.rst b/doc/INSTALL.md → docs/Installation.rst
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
@@ -6,7 +6,7 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
-BUILDDIR      = build
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/doc/THEORY_OF_DESIGN.md → docs/THEORY_OF_DESIGN.rst b/doc/THEORY_OF_DESIGN.md → docs/THEORY_OF_DESIGN.rst
diff --git a/docs/_static/README.md b/docs/_static/README.md
@@ -0,0 +1 @@
+This directory for sphinx
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
@@ -6,6 +6,15 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+# Add project root to pythonpath
+import os
+import sys
+
+from os.path import dirname,abspath
+sys.path.insert(0, dirname(dirname(abspath(__file__))))
+
+from constants import __version__
+
 project = 'Plant Tracer Web Application'
 copyright = '2024, Simson Garfinkel, Steve Barber, JoAnn Juzefyk, Eric Brenner'
 author = 'Simson Garfinkel, Steve Barber, JoAnn Juzefyk, Eric Brenner'
@@ -14,15 +23,37 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "myst_parser",
+]
+
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
+}
+
 
 templates_path = ['_templates']
-exclude_patterns = []
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+#html_theme = "furo"
 html_static_path = ['_static']
+
+# autodoc
+
+autoclass_content = "both"
+autodoc_default_options = {
+    "member-order": "bysource",
+    "special-members": "__init__",
+    "undoc-members": True,
+}
+autodoc_typehints_format = "short"
diff --git a/doc/demo_mode.md → docs/demo_mode.rst b/doc/demo_mode.md → docs/demo_mode.rst
diff --git a/doc/gallery.md → docs/gallery.rst b/doc/gallery.md → docs/gallery.rst
diff --git a/doc/gallery_learning_plan.md → docs/gallery_learning_plan.rst b/doc/gallery_learning_plan.md → docs/gallery_learning_plan.rst
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
diff --git a/...0_19-Zoom Meeting Graphing Whiteboard.png → ...0_19-Zoom Meeting Graphing Whiteboard.png b/...0_19-Zoom Meeting Graphing Whiteboard.png → ...0_19-Zoom Meeting Graphing Whiteboard.png
diff --git a/...m Analysis Results Calculation Sketch.png → ...m Analysis Results Calculation Sketch.png b/...m Analysis Results Calculation Sketch.png → ...m Analysis Results Calculation Sketch.png
diff --git a/doc/media/Gravitropism Results Page.png → docs/media/Gravitropism Results Page.png b/doc/media/Gravitropism Results Page.png → docs/media/Gravitropism Results Page.png
diff --git a/doc/media/image1.png → docs/media/image1.png b/doc/media/image1.png → docs/media/image1.png
diff --git a/doc/media/image10.png → docs/media/image10.png b/doc/media/image10.png → docs/media/image10.png
diff --git a/doc/media/image11.png → docs/media/image11.png b/doc/media/image11.png → docs/media/image11.png
diff --git a/doc/media/image12.png → docs/media/image12.png b/doc/media/image12.png → docs/media/image12.png
diff --git a/doc/media/image13.png → docs/media/image13.png b/doc/media/image13.png → docs/media/image13.png
diff --git a/doc/media/image14.png → docs/media/image14.png b/doc/media/image14.png → docs/media/image14.png
diff --git a/doc/media/image15.png → docs/media/image15.png b/doc/media/image15.png → docs/media/image15.png
diff --git a/doc/media/image16.png → docs/media/image16.png b/doc/media/image16.png → docs/media/image16.png
diff --git a/doc/media/image17.png → docs/media/image17.png b/doc/media/image17.png → docs/media/image17.png
diff --git a/doc/media/image18.png → docs/media/image18.png b/doc/media/image18.png → docs/media/image18.png
diff --git a/doc/media/image19.png → docs/media/image19.png b/doc/media/image19.png → docs/media/image19.png
diff --git a/doc/media/image2.png → docs/media/image2.png b/doc/media/image2.png → docs/media/image2.png
diff --git a/doc/media/image20.png → docs/media/image20.png b/doc/media/image20.png → docs/media/image20.png
diff --git a/doc/media/image21.png → docs/media/image21.png b/doc/media/image21.png → docs/media/image21.png
diff --git a/doc/media/image22.png → docs/media/image22.png b/doc/media/image22.png → docs/media/image22.png
diff --git a/doc/media/image23.png → docs/media/image23.png b/doc/media/image23.png → docs/media/image23.png
diff --git a/doc/media/image24.png → docs/media/image24.png b/doc/media/image24.png → docs/media/image24.png
diff --git a/doc/media/image25.png → docs/media/image25.png b/doc/media/image25.png → docs/media/image25.png
diff --git a/doc/media/image26.png → docs/media/image26.png b/doc/media/image26.png → docs/media/image26.png
diff --git a/doc/media/image27.png → docs/media/image27.png b/doc/media/image27.png → docs/media/image27.png
diff --git a/doc/media/image28.png → docs/media/image28.png b/doc/media/image28.png → docs/media/image28.png
diff --git a/doc/media/image29.png → docs/media/image29.png b/doc/media/image29.png → docs/media/image29.png
diff --git a/doc/media/image3.png → docs/media/image3.png b/doc/media/image3.png → docs/media/image3.png
diff --git a/doc/media/image4.png → docs/media/image4.png b/doc/media/image4.png → docs/media/image4.png
diff --git a/doc/media/image5.png → docs/media/image5.png b/doc/media/image5.png → docs/media/image5.png
diff --git a/doc/media/image6.png → docs/media/image6.png b/doc/media/image6.png → docs/media/image6.png
diff --git a/doc/media/image7.png → docs/media/image7.png b/doc/media/image7.png → docs/media/image7.png
diff --git a/doc/media/image8.png → docs/media/image8.png b/doc/media/image8.png → docs/media/image8.png
diff --git a/doc/media/image9.png → docs/media/image9.png b/doc/media/image9.png → docs/media/image9.png
diff --git a/doc/movie_player.md → docs/movie_player.rst b/doc/movie_player.md → docs/movie_player.rst
diff --git a/doc/resources.md → docs/resources.rst b/doc/resources.md → docs/resources.rst
diff --git a/doc/user story - tracking.md → docs/user story - tracking.rst b/doc/user story - tracking.md → docs/user story - tracking.rst
diff --git a/lib/ctools b/lib/ctools
diff --git a/requirements.txt b/requirements.txt
@@ -110,4 +110,4 @@ wsproto==1.2.0
 zappa==0.58.0
 zc.lockfile==3.0.post1
 zope.interface==6.1
-furo
+myst-parser