Support metadata for pyinfra plugins. #1457
Conversation
rod7760
force-pushed
the
group-operations-and-facts
branch
from
6578bd7 to
baa30b1
Compare
* Add pyinfra-metadata-schema-1.0.0.json. * Add pyinfra-metadata.toml with current plugins. * Add Jinja2 templating to sphinx build. * Extended build-public-docs.sh to build local docs. * Added generated index for facts and operations.
rod7760
force-pushed
the
group-operations-and-facts
branch
from
baa30b1 to
b4e02c5
Compare
|
Love this! I would move the Maybe we want to create a plugin registry with API (think Ansible Galaxy) |
|
Those both sound reasonable. That template folder is actually from an old implementation. I forgot to delete it. Whoops |
There was a problem hiding this comment.
This is awesome stuff @rod7760! Couple of bits to cleanup Daan already pointed out and good to go I think.
Community context: this is the precursor work that will enable us to generate other pyinfra projects docs inline on docs.pyinfra.com avoiding a disjointed mess of documentation websites.
| @@ -0,0 +1,550 @@ | |||
| "$schema" = "./pyinfra-metadata-schema-1.0.0.json" | |||
There was a problem hiding this comment.
Might be nice to have a script to regenerate this file in-repo since there's so many entries (probably only relevant to pyinfra core itself).
There was a problem hiding this comment.
Eh, might need to put the tags into machine readable format in the docstrings to do that though 🤔
|
Resolved the open comments. I moved Additionally, I now only render the We could also explicitly exclude files, but the jinja2 templating felt niche enough to include files explicitly. |
Remove old template dir Drop system-ops and system-facts Add pydantic to docs/metadata.py Move docs/metadata to pyinfra.api.metadata need to fix docs generation error for missing jinja2 vars Fix linting and only render subset of docs as jinja2 Update python3 -m http.server command in build-public-docs.sh
rod7760
force-pushed
the
group-operations-and-facts
branch
from
65e6ae8 to
fc7edac
Compare
Changes
Bench Test
Screenshot of Change
3.xat this time)scripts/dev-test.sh)scripts/dev-lint.sh)