diff --git a/.github/workflows/docs_dev.yml b/.github/workflows/docs_dev.yml index c55b0aab84..f0a4b1fca8 100644 --- a/.github/workflows/docs_dev.yml +++ b/.github/workflows/docs_dev.yml @@ -1,5 +1,6 @@ name: Docs Publish on: + workflow_dispatch: push: branches: [ main ] diff --git a/docs/source/_static/overrides.css b/docs/source/_static/overrides.css new file mode 100644 index 0000000000..c6a64ff837 --- /dev/null +++ b/docs/source/_static/overrides.css @@ -0,0 +1,3 @@ +:root { + --header-height: 0rem; +} diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index 515164542d..4b7c22a808 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -156,13 +156,9 @@ {{ js_tag(scriptfile) }} {%- endfor %} - - - - -{% endif %} - - - \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 4e89776131..ddc58fb81f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -21,7 +21,7 @@ project = 'rustworkx' copyright = '2021, rustworkx Contributors' - +docs_url_prefix = "ecosystem/rustworkx" # The short X.Y version. version = '0.13.0' @@ -42,7 +42,9 @@ 'sphinx_reredirects', 'qiskit_sphinx_theme', ] +html_static_path = ["_static"] templates_path = ['_templates'] +extra_css_files = ["overrides.css"] pygments_style = 'colorful' diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt index 57816784a6..32b3c6359c 100644 --- a/docs/source/requirements.txt +++ b/docs/source/requirements.txt @@ -1,10 +1,10 @@ m2r2 -sphinx>=3.0.0 +sphinx>=5.0 jupyter-sphinx pydot pillow>=4.2.1 reno>=3.4.0 -qiskit-sphinx-theme~=1.11.1 +qiskit-sphinx-theme~=1.12.0 matplotlib>=3.4 sphinx-reredirects sphinxemoji diff --git a/tox.ini b/tox.ini index 67d472c3d5..aeab7f94c5 100644 --- a/tox.ini +++ b/tox.ini @@ -60,6 +60,12 @@ commands = jupyter kernelspec list sphinx-build -W -d {toxinidir}/docs/build/.doctrees -b html source build/html {posargs} +[testenv:docs-clean] +skip_install = true +deps = +allowlist_externals = rm +commands = rm -rf {toxinidir}/docs/build {toxinidir}/docs/apiref + [testenv:black] basepython = python3 deps =