Skip to content

Commit

Permalink
ci: gh-pages building correctly
Browse files Browse the repository at this point in the history
- Bumps the Python version for building docs to 3.12
- Unpins sphinx-autoapi
- Removes sphinx-autodoc-typehints
  • Loading branch information
ns-rse committed Oct 16, 2024
1 parent 8429156 commit 61715f4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/sphinx_docs_to_gh_pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.9
python-version: 3.12
- name: Installing the Documentation requirements
run: |
pip3 install .[docs]
Expand Down
5 changes: 2 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
extensions = [
"autoapi.extension",
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinx.ext.coverage",
Expand Down Expand Up @@ -206,8 +205,8 @@
# sphinx-multiversion https://holzhaus.github.io/sphinx-multiversion/master/configuration.html
smv_tag_whitelist = r"^v\d+.*$" # Tags beginning with v#
smv_branch_whitelist = r"^main$" # main branch
# If testing changes locally comment out the above and the smv_branch_whitelist below instead. Replace the branch name
# you are working on ("ns-rse/466-doc-versions" in the example below) with the branch you are working on and run...
# If testing changes locally comment out the above and use the smv_branch_whitelist below instead. Replace the branch
# name you are working on ("ns-rse/466-doc-versions" in the example below) with the branch you are working on and run...
#
# cd docs
# sphinx-multiversion . _build/html
Expand Down
3 changes: 1 addition & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,7 @@ docs = [
"myst_parser",
"numpydoc",
"pydata_sphinx_theme",
"sphinx-autoapi==3.1.0b0",
"sphinx-autodoc-typehints",
"sphinx-autoapi",
"sphinx-multiversion",
"sphinx_markdown_tables",
"sphinx_rtd_theme",
Expand Down

0 comments on commit 61715f4

Please sign in to comment.