Add incipient documentation tooling #328
Merged
+35
−0
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 introduces an incipient version for documentation tooling in DAG Factory.
It introduces three requirements to create/generate documentation:
pymdown-extensions
(so we can leverage Snippets for injecting code from other files inline in the Markdown files)Also, it introduces three new hatch commands:
hatch run docs:build
: builds the docs locally, generating the correspondent static HTML website;hatch run docs:serve
: builds and serves the docs locally at localhost:8080;hatch run docs:release
: creates a version release using the version specified indagfactory/__init__.py
using MikeThis screenshot illustrates versioning:
This screenshot illustrates code snippets: