qc2nl / qc2

Facilitate the orchestration of quantum chemistry applications on quantum computers
https://qc2.readthedocs.io/
Apache License 2.0
3 stars 2 forks source link

Format docstrings and add sphinx docs #47

Closed Cmurilochem closed 7 months ago

Cmurilochem commented 10 months ago

This PR adresses #46.

Sections to add in the documentation

Instructions on how to visualise the final HTML documentation

Since we our repo is still Private, we are not yet able to deploy the documentation directly from the CI/CD to ReadTheDocs or Github pages.

As a provisory solution to visualise the final html doc file, proceed as follows:

  1. First, make sure that you have installed qc2 using the dev option, e.g.,:

    python3 -m pip install -e .[dev,pennylane]

    This will install all functionalities of sphinx.

  2. Go to the docs directory and compile the documentation via the command:

    make html
  3. Finally, open the generated _build/html/index.html file using your browser.