Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate HTML documentation from schema #25

Open
Galileo-Galilei opened this issue Aug 18, 2023 · 3 comments
Open

Generate HTML documentation from schema #25

Galileo-Galilei opened this issue Aug 18, 2023 · 3 comments

Comments

@Galileo-Galilei
Copy link
Owner

Galileo-Galilei commented Aug 18, 2023

Description

yaml or python are very explicit, but hard to show to managers / stakeholders / business teams. Being able to convert schema to prettier and more organized HTML documents would definitely help documentation efforts and consistency. it would be great of kedro-pandera could generate these docs automatically.

quoting @datajoely

Again dbt has had this for years and it's just a no brainer, we could easily generate static docs describing what data is in the catalog, associated metadata and tests.
There is also an obvious integration point with enterprise catalogs like Alation/Colibra/Amundsen

Context

Dataset documentation is a much required feature to interact with non technical teams.

Possible Implementation

Add a CLI kedro pandera doc which would perform the conversion of all datasets with schemas.

The real question lies in the responsibility of generating the HTML from schema. This likely
belongs to pandera itself.

@datajoely
Copy link

Perhaps this could be kedro catalog docs and is built in to Kedro / Kedro-Viz itself

@Galileo-Galilei
Copy link
Owner Author

I think several documentation-related features might end up in kedro, but It would be nice to be able to iterate faster and not be tied too much by retrocompatibility and minor releases schedules, at least for the beginning of development.

@datajoely
Copy link

I think if we were to go down this route - I think the libraries which generate API docs for things like Click are a decent parallel as they also follow and introspection to HTML content pattern:

https://sphinx-click.readthedocs.io/en/latest/
https://github.com/DataDog/mkdocs-click

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants