Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Set up a Sphinx-based documentation page for this project.
Details and comments
First
sphinx-quickstart
was used to generate the basic framework. After that, a page for each type of documentation was created and included in the sidebar via atoctree
indocs/index.rst
.For the API Reference, some changes were made to the docstrings in the corresponding
__init__.py
to accommodate the html pages.Needed installs:
sphinx
qiskit_sphinx_theme
nbsphinx
(Sphinx extension that enables to use Jupyter notebooks in documentation)