Add logo, update documentation #110
Conversation
- Add formatted list of gates to documentation
- Summarise README.md, move some content to documentation
* Move examples to documentation
* Move "Getting started" to documentation, summarise and replace by "Quick start"
- Add logo to README.md
- Add logo to documentation
- Add custom CSS styles to documentation
- Enable MyST parser in documentation `conf.py`
- Add MyST parser to documentation requirements
| @@ -1,2 +1,3 @@ | |||
| sphinx ~= 7.2 | |||
| sphinx_rtd_theme | |||
| myst_parser | |||
There was a problem hiding this comment.
Do you want to add a version to this?
Yup, the files in the artifact generated by the CI action seem to be all good! Would it be possible to trigger a build and deploy without releasing a new version? Some links in the README.md now refer to new sections in the documentation. |
Yes that is possible, we just need to merge the changes into the main branch... |
|
Added one last tweak to the logo since the previous version's colours were a bit too faded, the new one is here. |
- Add formatted list of gates to documentation
- Summarise README.md, move some content to documentation
* Move examples to documentation
* Move "Getting started" to documentation, summarise and replace by "Quick start"
- Add logo to README.md
- Add logo to documentation
- Add custom CSS styles to documentation
- Enable MyST parser in documentation `conf.py`
- Add MyST parser to documentation requirements
conf.pyDocumentation seems to be rendering fine (tested directly by running the GitHub build action). @cqc-melf would it be possible to trigger a build and deploy without releasing a new version? Some links in the
README.mdnow refer to new sections in the documentation.The MyST parser is currently being used to parse markdown files into the documentation, and will be useful in a future PR where we embed the Jupyter notebooks directly in the documentation.
Hope everyone likes the logo!