Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Sphinx theme #18

Merged
merged 2 commits into from
Oct 19, 2023
Merged

Update Sphinx theme #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b61f69
Update Sphinx theme
arnaucasau Sep 25, 2023
878afe8
contents directive removed
arnaucasau Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@
copyright = '2022, Jake Lishman'
author = 'Jake Lishman'
version = qiskit_qasm3_import.__version__
release = qiskit_qasm3_import.__version__

extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
'qiskit_sphinx_theme',
]
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# Document the docstring for the class and the __init__ method together.
autoclass_content = "both"

html_theme = 'alabaster'
html_theme = "qiskit-ecosystem"
html_title = f"{project} {release}"

intersphinx_mapping = {
"qiskit-terra": ("https://qiskit.org/documentation", None),
Expand Down
7 changes: 5 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
OpenQASM 3 Importer for Qiskit
==============================

.. toctree::
:hidden:

Home <self>

.. module:: qiskit_qasm3_import

This project is a temporary importer for parsing simple OpenQASM 3 programmes
Expand All @@ -12,8 +17,6 @@ while various technical details are decided on the Qiskit side, as switching
parsing frameworks and so on is far more complex for code brought into Qiskit,
as the stability guarantees are much stronger.

.. contents::


API
---
Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ pylint~=2.15.0
pytest>=6.0
reno>=3.4.0
Sphinx>=4.0
qiskit_sphinx_theme~=1.16.0