Implement doc tree builder with toml, yaml and custom format - Githubissues

pulp / pulp-docs

Python Package to help aggregating Pulp's multirepo ecosystem into a unified doc.

https://pedro-psb.github.io/pulp-docs/

2 stars 4 forks source link

Implement doc tree builder with toml, yaml and custom format #89

Closed pedro-psb closed 2 weeks ago

pedro-psb commented 2 weeks ago

This is to help create fixtures for testing regressions, so it's easier to refactor.

Motivation:

Is hard to navigate through a three of files and have a glimpse on what is meaningfull there for a test. Using a declarative file makes it more digestable, plus it can have more localized comments.
It's cumbersome to handcraft a tree of files if its more than a few ones. Plain text is easy.
Tests helps me developing, and I didn't do it here yet because this tool requires some non-trivial test setups.