Merge pull request #191 from RTIInternational/189-api-docs-are-broken

189 api docs are broken
RTIInternational · Jun 27, 2024 · f339dd8 · f339dd8
2 parents 4fe47b3 + 9c529b1
commit f339dd8
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 253 deletions.
diff --git a/.github/workflows/documentation-publish.yml b/.github/workflows/documentation-publish.yml
@@ -3,7 +3,7 @@ name: documentation
 on:
   push:
     tags: [ 'v*.*.*' ]
-    # branches: [112-add-documentation]
+    # branches: [189-api-docs-are-broken]
 
 permissions:
   contents: write
@@ -21,7 +21,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install sphinx pydata-sphinx-theme myst-nb sphinx-design sphinx-autoapi numpydoc ghp-import -e .
+          pip install sphinx==7.2.6 pydata-sphinx-theme myst-nb sphinx-design sphinx-autoapi==3.0.0 numpy==1.26.4 numpydoc ghp-import pickleshare -e .
 
       - name: Sphinx build
         run: |
@@ -30,4 +30,4 @@ jobs:
 
       - name: Run ghp-import
         run: |
-          ghp-import -n -p -f docs/sphinx/_build/html
+          ghp-import -n -p -f -o docs/sphinx/_build/html
diff --git a/README.md b/README.md
@@ -42,8 +42,8 @@ $ poetry add git+https://github.com/RTIInternational/teehr.git#[BRANCH TAG]
 
 Use Docker
 ```bash
-$ docker build -t teehr:v0.3.25 .
-$ docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.3.25 jupyter lab --ip 0.0.0.0 $HOME
+$ docker build -t teehr:v0.3.26 .
+$ docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.3.26 jupyter lab --ip 0.0.0.0 $HOME
 ```
 
 ## Examples

diff --git a/docs/images/TEEHR_Icon_DarkMode.png b/docs/images/TEEHR_Icon_DarkMode.png
diff --git a/docs/sphinx/changelog/index.rst b/docs/sphinx/changelog/index.rst
@@ -1,6 +1,21 @@
 Release Notes
 =============
 
+
+0.3.26 - 2024-06-27
+--------------------
+
+Added
+^^^^^
+* Dark theme logo for sphinx documentation.
+* Added the `pickleshare` package to dev dependency group to fix `ipython` directive in sphinx documentation.
+
+Changed
+^^^^^^^
+* Pinned `sphinx-autodoc` to v3.0.0 and `numpy` to v1.26.4 in `documentation-publish.yml` to fix the API documentation build.
+* Removed unused documentation dependencies from dev group.
+
+
 0.3.25 - 2024-06-06
 --------------------
 

diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -31,16 +31,11 @@
     "sphinx.ext.autodoc",
     # "sphinx.ext.napoleon",
     "numpydoc",
-    # "sphinx.ext.coverage",
-    # "sphinx.ext.linkcode",
     "sphinx_design",  # gives us grids and other design elements
     "autoapi.extension",
     "sphinx.ext.autosummary",
-    # "sphinx_click",
-    # "myst_parser",
     "sphinx.ext.viewcode",  # links to source code
     "sphinx.ext.githubpages",
-    # "nbsphinx"  # for rendering jupyter notebooks  ?? or myst-nb ??
     "myst_nb",
     'IPython.sphinxext.ipython_console_highlighting',
     'IPython.sphinxext.ipython_directive'
@@ -86,18 +81,22 @@
 # a list of builtin themes.
 #
 html_theme = 'pydata_sphinx_theme'
+html_static_path = ['_static']
 html_theme_options = {
   "show_toc_level": 2,
   "github_url": "https://github.com/RTIInternational/teehr",
   "footer_center": ["footer_center.html"],
-  # "favicons": [{"href": "../images/teehr_favicon_16.png"}]
+  "logo": {
+      "image_light": "../images/teehr.png",
+      "image_dark": "../images/TEEHR_Icon_DarkMode.png",
+   }
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-html_logo = "../images/teehr.png"
+# html_static_path = ['_static']
+# html_logo = "../images/teehr.png"
 html_css_files = [
     # "css/getting_started.css",
     "css/teehr.css",