Skip to content

Commit

Permalink
Various docs changes for CI (#253)
Browse files Browse the repository at this point in the history
  • Loading branch information
woodsp-ibm committed Apr 11, 2023
1 parent 66f5158 commit dd2ad0d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
11 changes: 9 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@
"sphinx.ext.extlinks",
"sphinx_design",
"jupyter_sphinx",
"sphinx_autodoc_typehints",
"reno.sphinxext",
"sphinx.ext.doctest",
"nbsphinx",
Expand All @@ -108,7 +107,9 @@
nbsphinx_timeout = 360
nbsphinx_execute = os.getenv("QISKIT_DOCS_BUILD_TUTORIALS", "never")
nbsphinx_widgets_path = ""
nbsphinx_thumbnails = {}
nbsphinx_thumbnails = {
"**": "_static/no_image.png",
}

spelling_word_list_filename = "../.pylintdict"
spelling_filters = ["lowercase_filter.LowercaseFilter"]
Expand All @@ -123,6 +124,12 @@
# -----------------------------------------------------------------------------
# Autodoc
# -----------------------------------------------------------------------------
# Move type hints from signatures to the parameter descriptions (except in overload cases, where
# that's not possible).
autodoc_typehints = "description"
# Only add type hints from signature to description body if the parameter has documentation. The
# return type is always added to the description (if in the signature).
autodoc_typehints_description_target = "documented_params"

autodoc_default_options = {
"inherited-members": None,
Expand Down
3 changes: 1 addition & 2 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ pylatexenc>=1.4
stestr>=2.0.0
ddt>=1.2.0,!=1.4.0
reno>=3.4.0
Sphinx>=1.8.3,!=3.1.0,!=5.2.0,!=5.2.0.post0
Sphinx>=5.0
sphinx-design>=0.2.0
sphinx-gallery
sphinx-autodoc-typehints<1.14.0
sphinxcontrib-spelling
jupyter-sphinx
discover
Expand Down
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ deps =
-r{toxinidir}/requirements.txt
-r{toxinidir}/requirements-dev.txt
sphinx-intl
jupyter
commands =
sphinx-build -W -T --keep-going -b gettext docs/ docs/_build/gettext {posargs}
sphinx-intl -c docs/conf.py update -p docs/_build/gettext -l en -d docs/locale
Expand Down

0 comments on commit dd2ad0d

Please sign in to comment.