Repository navigation
docs(api): establish documentation infrastructure, autogenerated api reference, and agent standards - #22
Merged
Conversation
…ine module exports
…ges deployment workflow
5 tasks done
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.
Description
This PR resolves #8 by establishing a modern documentation infrastructure, an autogenerated API reference across all public subpackages of STRIDE, and codified documentation governance standards for AI agents.
Key enhancements:
mkdocs.yml), search, KaTeX math typesetting (pymdownx.arithmatex), dark/light mode toggle, and responsive navigation.docs/api/usingmkdocstrings[python]with Google-style handler acrossstride.datasets,stride.drift,stride.models,stride.plotting,stride.xai.boundary,stride.xai.clustering,stride.xai.importance,stride.xai.recurrence,stride.xai.stats, andstride.exceptions.src/stride/to strict Google-style docstrings (parameter types strictly in Python 3.10+ signatures, LaTeX math syntax, explicitRaisessections).docsextra and included it inallinpyproject.toml; configured Ruff pydocstyle Google convention withD417enforcement..github/workflows/docs.ymlto run strict documentation builds (mkdocs build --strict) on pull requests and deploy automatically to GitHub Pages on release or push tomain..agents/rules/documentation_standards.mdand integrated triggers inAGENTS.md,.agents/acs.yaml, and.agents/rules/python_package_standards.md.Closes #8
Type of Change
Verification
ruff check .passes with zero errors (All checks passed!)ruff format --check .passes with zero formatting issues (113 files already formatted)python -m unittest discover testspasses with 42 tests passing (OK)mkdocs build --strictbuilds successfully in strict mode with 0 warnings