Skip to content

Commit 9b79212

Browse files
authored
misc: Add link in the README to the hosted reference docs (#233)
Changes proposed in this pull request: - Add information in the README about how to find the reference documentation hosted online.
1 parent 592cb16 commit 9b79212

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

.github/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff 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

9293
For 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

100104
1. Ensure you have used one of the install options above.
101105
1. 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

0 commit comments

Comments
 (0)