Build conceptual and API docs with Sphinx #30
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bamarsha
reviewed
Jan 7, 2022
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
bamarsha
approved these changes
Jan 7, 2022
|
@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! |
bamarsha
approved these changes
Jan 13, 2022
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.