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

Automated documentation generation using mkdocs and GitHub Actions #46

Open
sujaypatil96 opened this issue Jan 9, 2025 · 0 comments
Open
Labels
DevOps CI/CD (GitHub Actions, etc.), package management (poetry), etc.

Comments

@sujaypatil96
Copy link
Collaborator

Automated documentation generation in this repo should be pretty straightforward since we have only one script (etl.py) and we've been pretty good about maintaining the docstrings for the classes and methods that we've defined/used in that script.

We should do another pass of reviewing those docstrings and making sure they're still accurate (method signature, description, etc.).

Once that's done, we can use the mkdocs framework like we do in a lot of our other repositories to have a public-facing website capturing documentation relevant to the repository. We can use mkdocs plugins/mkdocstrings to first appropriately format, and then automatically parse out documentation sections into web pages, and have them be rendered using mkdocs and deployed to GitHub Pages.

All of these processes should be automated using GitHub Actions.

@sujaypatil96 sujaypatil96 added the DevOps CI/CD (GitHub Actions, etc.), package management (poetry), etc. label Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DevOps CI/CD (GitHub Actions, etc.), package management (poetry), etc.
Projects
None yet
Development

No branches or pull requests

1 participant