docs: fixes for api docs#35
Conversation
* chore: point badge at main branch * chore: copy readme files
|
also pulls in |
CalMacCQ
left a comment
CalMacCQ
left a comment
There was a problem hiding this comment.
Looks great, thanks Ollie. I have rebuilt the docs locally on this branch and the number of warnings is dramatically reduced from >3000 to 101. There are still a lot of wanings that look like this.
WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils]
I think this could be a whitespace/templating issue. We should consider resolving all of the warnings so we can run a super strict sphinx build in C.I.
|
no warnings now, and i'm made warnings error out |
You can also accomplish this by passing the https://github.com/Quantinuum/guppy-docs/blob/main/justfile#L17 |
ah that's probably better place for control, i'll remove and then merge |
* add in the sphinx docs build * update .gitignore to exclude generated files from source control * move example notebooks into a subdirectory of docs * add comment to conf.py * small change to sphinx conf.py * update conf.py again * add docs workflow * update workflow title * Apply suggestions from code review Co-authored-by: Oliver Backhouse <olbackhouse@gmail.com> * ignore checkpoints * remove 'minimal' cells from notebook examples * add jupyter as a docs dependency * mention docs in the README * change workflow back to run on PRs * docs: fixes for api docs (#35) * use strict build in C.I. * add separate publish workflow that runs on releases * rm duplciate * fix missing 'n' --------- Co-authored-by: Oliver Backhouse <olbackhouse@gmail.com>
3 participants
No description provided.