-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Build conceptual and API docs with Sphinx #30
Conversation
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
…e/pyqir into cgranade/sphinx-docs
@SamarSha: Thanks for the review, Sarah! We should be good to merge soon, I think. Looking into markdownlint and link checking in more detail, it seems two of the errors were actual errors caused by using ordinary links instead of Sphinx-aware links, while the rest were due to false positives (DavidAnson/markdownlint#479 for upstream feature request). There may be a workaround for the false positives, will take a few minutes to try that out. |
@SamarSha: To fix the CI warnings, I wound up having to fix the missing config files for markdownlint and cspell. I realize you approved, but the PR has changed a bit since then thanks to the CI issues; if you'd like to take another look, please let me know and I'll hold off on merging. Thanks! |
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
This PR adds support for building conceptual and API documentation using Sphinx, and for publishing the resulting documentation as a build artifact and to GitHub Pages. In particular, this PR focuses on setting up infrastructure and publishing pipelines for docs, but there's significant work remaining to make sure that API docs have complete coverage.
This PR is progress towards, but does not completely fix #28.