Qiskit / red-queen

Quantum software benchmarking tool
Apache License 2.0
18 stars 15 forks source link

Adding Sphinx for Documentation #36

Open Lementknight opened 2 years ago

Lementknight commented 2 years ago

I am currently working on integrating Sphinx, so that we can facilitate better documentation building.

mtreinish commented 2 years ago

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
Lementknight commented 2 years ago

Where do I make this change?