HTML templates should come from qiskit_sphinx_theme, rather than the repository. Otherwise, you risk the docs not rendering correctly. I suspect these were copied and pasted from another project.
The custom_directives.py were also copied and pasted but not being used by this repository. (They define custom RST directives, but none appear in search.)
Finally, these CSS files are not necessary:
gallery.css is used by sphinx-gallery, which is not used by this repository.
custom.css defines rules for .toggle, which is no longer used in qiskit_sphinx_theme.
style.css only has holdover rules from when qiskit_sphinx_theme used to be based on Read The Docs.
Details and comments
Warning: I could not get the docs to build on my M1 due to Apple Silicon issues, so I have not built the docs locally.
mrossinek
commented
1 year ago
Summary
HTML templates should come from qiskit_sphinx_theme, rather than the repository. Otherwise, you risk the docs not rendering correctly. I suspect these were copied and pasted from another project.
The
custom_directives.pywere also copied and pasted but not being used by this repository. (They define custom RST directives, but none appear in search.)Finally, these CSS files are not necessary:
gallery.cssis used bysphinx-gallery, which is not used by this repository.custom.cssdefines rules for.toggle, which is no longer used inqiskit_sphinx_theme.style.cssonly has holdover rules from when qiskit_sphinx_theme used to be based on Read The Docs.Details and comments
Warning: I could not get the docs to build on my M1 due to Apple Silicon issues, so I have not built the docs locally.