Add Great Docs documentation site#44
Merged
Merged
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
…ntain permissions' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
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
2 participants
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.
Summary
Adds a Great Docs documentation setup for
secure.This PR introduces:
great-docs.ymlfor generated API documentationmain.gitignoreuvdev dependency forgreat-docs, limited to Python 3.11+Details
The generated documentation configuration includes:
https://typeerror.com/secure/.qmdsupportThe docs workflow builds the site with Python 3.11, installs Great Docs, runs
great-docs build, stores the generated HTML as an artifact, and deploys to GitHub Pages on pushes tomain.Notes
securestill supports Python 3.10+. Since Great Docs requires Python 3.11+, the dev dependency is guarded with a Python version marker so documentation tooling does not raise the package runtime requirement.