File tree Expand file tree Collapse file tree 1 file changed +8
-4
lines changed
Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Original file line number Diff line number Diff line change @@ -85,17 +85,21 @@ pytest
8585
8686## Usage
8787
88- See the [ Jupyter notebooks] ( ../examples ) .
88+ See the [ Jupyter notebooks examples] ( ../examples ) and the
89+ [ Q-CTRL Open Controls reference documentation] ( https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/ ) .
8990
9091## Contributing
9192
9293For general guidelines, see [ Contributing] ( https://github.com/qctrl/.github/blob/master/CONTRIBUTING.md ) .
9394
9495### Building documentation
9596
96- Documentation generation relies on [ Sphinx] ( http://www.sphinx-doc.org ) . Automated builds are done on each merge to master.
97+ Documentation generation relies on [ Sphinx] ( http://www.sphinx-doc.org ) .
98+ The reference documentation for the latest released version of
99+ Q-CTRL Open Controls is hosted online in the
100+ [ Q-CTRL documentation website] ( https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/ ) .
97101
98- To build locally:
102+ To build it locally:
99103
1001041 . Ensure you have used one of the install options above.
1011051 . Execute the make file from the docs directory:
@@ -107,7 +111,7 @@ To build locally:
107111 poetry run make html
108112 ```
109113
110- If using setuptools :
114+ If using pip :
111115
112116 ` ` ` bash
113117 cd docs
You can’t perform that action at this time.
0 commit comments