This repository has been archived by the owner on Aug 14, 2024. It is now read-only.
Adding Sphinx for Documentation #36
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Header Improvements Co-authored-by: Matthew Treinish <[email protected]>
Header Improvement Co-authored-by: Matthew Treinish <[email protected]>
Updating Header Co-authored-by: Matthew Treinish <[email protected]>
Co-authored-by: danielleodigie <[email protected]>
Co-authored-by: Raynel Sanchez <[email protected]>
mtreinish
reviewed
Aug 10, 2022
mtreinish
reviewed
Aug 12, 2022
docs/conf.py
Outdated
Comment on lines
41
to
43
| 'jupyter_sphinx', | ||
| 'reno.sphinxext', | ||
| 'sphinx.ext.intersphinx', |
docs/conf.py
Outdated
Comment on lines
79
to
82
| # Intersphinx configuration | ||
| intersphinx_mapping = { | ||
| 'qiskit': ('https://qiskit.org/documentation/', None), | ||
| } |
|
Once you apply this change I think this is ready to go for a default config. There isn't any content yet but we can add that later (along with a ci config to build documentation on each commit). diff --git a/tox.ini b/tox.ini
index 95ed6e7..3e3e8b7 100644
--- a/tox.ini
+++ b/tox.ini
@@ -34,5 +34,8 @@ deps =
commands = black {posargs} red_queen/
[testenv:docs]
+deps =
+ qiskit_sphinx_theme
+ -r{toxinidir}/requirements.txt
commands =
sphinx-build -b html {posargs} docs/ docs/_build/html |
|
Where do I make this change? |
In this commit I added the sphinx package to the requirements.txt file in the red-queen directory
I added dependencies to the tox.ini in the [testenv:docs] section
In this commit I removed spinx from this requirements.txt file as it is now included due to the previous commit
I added Sphinx to the list of dependencies in for [testenv:docs] in the tox.ini folder
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I am currently working on integrating Sphinx, so that we can facilitate better documentation building.