Closed Cmurilochem closed 7 months ago
This PR adresses #46.
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.
Private
ReadTheDocs
As a provisory solution to visualise the final html doc file, proceed as follows:
First, make sure that you have installed qc2 using the dev option, e.g.,:
qc2
dev
python3 -m pip install -e .[dev,pennylane]
This will install all functionalities of sphinx.
sphinx
Go to the docs directory and compile the documentation via the command:
docs
compile
make html
Finally, open the generated _build/html/index.html file using your browser.
_build/html/index.html
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 toReadTheDocs
or Github pages.As a provisory solution to visualise the final html doc file, proceed as follows:
First, make sure that you have installed
qc2
using thedev
option, e.g.,:This will install all functionalities of
sphinx
.Go to the
docs
directory andcompile
the documentation via the command:Finally, open the generated
_build/html/index.html
file using your browser.