docs: publish documentation site - #336
Open
Mattsface wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
Why
Links from the README currently point to Markdown files inside the repository, so GitHub opens them in its file-preview interface. The documentation should have stable, reader-friendly pages and clean URLs.
What changed
mainthrough the official GitHub Pages artifact flow./methods/,/async/, and/public-api/.Validation
mkdocs build --strict --site-dir sitegit diff --checkpoetry run pytest tests/ --ignore=tests/external_tests: 1,099 passedRisk and scope
Low runtime risk: package code and public behavior are unchanged. The new dependency pins are used only to build documentation. Deployment is restricted to
main; pull requests build the site without publishing it.The
v1.1.0tag and release and PyPI publishing are intentionally unchanged.