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

flowsa user guide #400

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

flowsa user guide #400

wants to merge 6 commits into from

Conversation

catherinebirney
Copy link
Collaborator

@catherinebirney catherinebirney commented Jan 12, 2024

Still a work in progress

@catherinebirney
Copy link
Collaborator Author

@bl-young suggested

I wonder if we could use something like
https://about.readthedocs.com/
and/or https://github.com/mkdocs/mkdocs
for rendering your documentation in a nice way

@WesIngwersen
Copy link
Collaborator

@catherinebirney let us know when its ready for review and you can assign me and i might assign 1 or 2 others, thanks

@WesIngwersen
Copy link
Collaborator

@bl-young suggested

I wonder if we could use something like https://about.readthedocs.com/ and/or https://github.com/mkdocs/mkdocs for rendering your documentation in a nice way

I found a few different USEPA code repos that are using readthedocs, so there is a precedent there
https://epanet22.readthedocs.io/en/latest/
https://omega2.readthedocs.io/en/2.3.0/

and here is one using Sphinx
https://usepa.github.io/WNTR/

@WesIngwersen
Copy link
Collaborator

I created a discussion for the user guide
#403

@bl-young bl-young added this to the user_guide milestone Mar 25, 2024
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

Successfully merging this pull request may close these issues.

None yet

3 participants