flowsa user guide

[catherinebirney]

Still a work in progress

[catherinebirney]

@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]

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

[WesIngwersen]

@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]

I created a discussion for the user guide https://github.com/USEPA/flowsa/discussions/403