Skip to content

Commit

Permalink
Fix docs deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Jun 4, 2024
1 parent 83a4ddc commit 997d1d8
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:
ref: gh-pages
fetch-depth: 0

- uses: actions/download-artifact@v2
- uses: actions/download-artifact@v4
name: Download weylchamber-docs artifact
with:
name: weylchamber-docs
Expand Down
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ The weylchamber package
<img src="https://img.shields.io/badge/github-qucontrol/weylchamber-blue.svg" alt="Source code on Github" />
</a><a href="https://pypi.python.org/pypi/weylchamber">
<img src="https://img.shields.io/pypi/v/weylchamber.svg" alt="weylchamber on the Python Package Index" />
</a><a href="https://weylchamber.readthedocs.io/en/latest/?badge=latest">
<img src="https://readthedocs.org/projects/weylchamber/badge/?version=latest" alt="Documentation Status" />
</a><a href="https://github.com/qucontrol/weylchamber/actions?query=workflow%3ADocs">
<img src="https://github.com/qucontrol/weylchamber/actions/workflows/docs.yml/badge.svg?branch=master" alt="Documentation Status" />
</a><a href="https://opensource.org/licenses/BSD-3-Clause">
<img src="https://img.shields.io/badge/License-BSD-green.svg" alt="BSD License" />
</a>
Expand All @@ -18,10 +18,10 @@ The weylchamber package
Python package for analyzing two-qubit gates in the Weyl chamber

Development of the ``weylchamber`` package happens on `Github`_.
You can read the full documentation at `ReadTheDocs`_.
You can read the full documentation at `online`_.


.. _ReadTheDocs: https://weylchamber.readthedocs.io/en/latest/
.. _online: https://qucontrol.github.io/weylchamber/


Installation
Expand Down Expand Up @@ -61,4 +61,4 @@ To use ``weylchamber`` in a project::

See the Tutorial_ for details.

.. _Tutorial: https://weylchamber.readthedocs.io/en/latest/tutorial.html
.. _Tutorial: https://qucontrol.github.io/weylchamber/master/tutorial.html
12 changes: 4 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ def run_apidoc(app):
'sphinx.ext.inheritance_diagram',
'dollarmath',
'sphinx_autodoc_typehints',
'docs_versions_menu',
]

extensions.append('nbsphinx')
Expand Down Expand Up @@ -209,16 +210,11 @@ def patched_parse(self):

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

# on_rtd is whether we are on readthedocs.org, this line of code grabbed from
# docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
#html_theme = 'sphinxdoc'

# Theme options are theme-specific and customize the look and feel of a theme
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ def get_version(filename):
'sphinx-autobuild',
'sphinx-autodoc-typehints',
'sphinx_rtd_theme',
'docs-versions-menu',
'twine',
'watermark',
'wheel',
Expand Down

0 comments on commit 997d1d8

Please sign in to comment.