docs: Diátaxis documentation site with strict build passing - #67
Merged
Conversation
…rence
Rework the documentation site around the Diátaxis model (tutorials, how-to,
reference, explanation), wire up mkdocs-material with auto-generated API
pages from source docstrings, and fix coherence gaps between prose and code.
- Add mkdocs.yml with mkdocs-material, mkdocs-gen-files (API autogen),
mkdocs-literate-nav, mkdocstrings and htmlproofer
- Add tutorials/quickstart.md, howto/{index,usage}.md,
reference/{example-scripts,input-format,output-format}.md,
explanation/{architecture,extending-steps,input-prioritization,mrv-specification}.md,
glossary.md
- Document SmallFleetRunnerParams, FlightRunner single-flight usage, and
the step registry / Protocol extension pattern
- Normalise docstrings (Google style) on fleet/parsing/weather/emissions/
climate runners for mkdocstrings rendering
- Update README/CONTRIBUTING with new doc layout and build commands
- Switch declared license to EUPL 1.2 in pyproject.toml
- Add docs CI workflow and pydocstyle configuration
- Enable --unsafe for check-yaml to allow mkdocs !!python/name: tags
Skip htmlproofer validation on `reference/api/*` pages. mkdocstrings emits relative cross-refs (e.g. `flight/#pyneats.runners.flight.FlightRunner`) that resolve correctly at the served URL but htmlproofer's file-based lookup doesn't follow `use_directory_urls`, producing false 404s. mkdocstrings already validates symbol cross-refs at build time. Also normalise `core/views.py` module docstring to Google style.
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
mkdocs build --strictpasses cleanTest plan
make docs-build— 0 warnings, 0 errorsmake docs-serveand browse