Skip to content

Feature Request: Build pyRACF Documentation With Jinja Templates #89

@lcarcaramo

Description

@lcarcaramo

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/

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions