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

Build tool to automatically compile sections of the FATES code to provide as reference to the user #46

Open
glemieux opened this issue Aug 24, 2023 · 0 comments
Labels
enhancement Feature that improves the function of the guide outside of content

Comments

@glemieux
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
There are some parts of the fates code that we would like to be able to reference in the user's guide, such as a table of all the possible history output variable options, as opposed to just pointing them to the code itself, which can break during refactoring and other updates.

Describe the solution you'd like
Develop a tool using docstrings or some other method to reference the fates repo main code. Ideally this would automatically be kicked off if an update to the relevant sections of code were noticed.

Describe alternatives you've considered
Not really

Additional context
N/A

@glemieux glemieux added the enhancement Feature that improves the function of the guide outside of content label Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature that improves the function of the guide outside of content
Projects
None yet
Development

No branches or pull requests

1 participant