Skip to content

Feature Request: Build pyRACF Documentation With Jinja Templates #89

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

Open
lcarcaramo opened this issue Nov 13, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@lcarcaramo
Copy link
Member

Is your feature request related to a problem? Please describe.
Updating the pyRACF documentation is highly error prone in terms of formatting mistakes and inadvertent divergence from the established formatting conventions.

Describe the solution you'd like
Since the GitHub pages documentation for the pyRACF follows a set of conventions, it would helpful for enforcing formatting conventions and avoiding small formatting mistakes if we instead used Jinja templates to generate our documentation.

Describe alternatives you've considered
N/A

Additional context

pyRACF Documentation: https://ambitus.github.io/pyracf/
pyRACF Documentation (code): https://github.com/ambitus/pyracf/tree/gh-pages
Jinja: https://www.geeksforgeeks.org/getting-started-with-jinja-template/

@lcarcaramo lcarcaramo added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant