Skip to content

Commit

Permalink
Fix docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
HGSilveri committed Jan 2, 2025
1 parent 21a0ffa commit f1aeb69
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# For generating documentation.
Sphinx < 7
Sphinx < 9
sphinx-rtd-theme # documentation theme
sphinx_autodoc_typehints == 1.21.3
sphinx_autodoc_typehints == 2.5.0
nbsphinx
nbsphinx-link
ipython >= 8.10 # Avoids bug with code highlighting
Expand Down
8 changes: 8 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,20 @@
# Source file suffixes
source_suffix = [".rst", ".md"]

# Suppress warnings
suppress_warnings = ["config.cache"]

# Autodoc config
autosummary_generate = True
autodoc_member_order = "bysource"
autodoc_typehints = "none"
typehints_defaults = "comma"

autodoc_type_aliases = {
"ArrayLike": "ArrayLike",
"QubitId": "QubitId",
}

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down

0 comments on commit f1aeb69

Please sign in to comment.