Skip to content

Conversation

@Guillermo-Mijares-Vilarino

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 a toctree in docs/index.rst.

For the API Reference, some changes were made to the docstrings in the corresponding __init__.py to accommodate the html pages.

Captura de pantalla 2023-04-03 a las 19 59 41
Captura de pantalla 2023-04-03 a las 20 00 19
Captura de pantalla 2023-04-03 a las 20 01 26

Captura de pantalla 2023-04-03 a las 20 01 47
Captura de pantalla 2023-04-03 a las 20 02 05
Captura de pantalla 2023-04-03 a las 20 02 41
Captura de pantalla 2023-04-03 a las 20 03 48

Captura de pantalla 2023-04-03 a las 20 04 08

Needed installs:

  • sphinx
  • qiskit_sphinx_theme
  • nbsphinx (Sphinx extension that enables to use Jupyter notebooks in documentation)

@Guillermo-Mijares-Vilarino Guillermo-Mijares-Vilarino requested a review from a team as a code owner April 3, 2023 18:04
@CLAassistant
Copy link

CLAassistant commented Apr 3, 2023

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants