Create Documentation Website

[krowvin]

Should we create a documentation website custom or would it be better to implement a github actions process to run pydoc?

A custom website could allow us to create custom examples with catered documentation.

Pydoc is more automated and easier to get going to actually document some of the features available now in repgen5 (like the dunder methods for Value)

[krowvin]

Got the documentation creating locally and setup the action for it. Action seems to complete but adding the step to write the docs fails. Possibly need this enabled unless someone knows a better way to auto write/generate the docs!

Settings > Actions > General

• Action Run Error

[MikeNeilson]

Alternatively, hooking up to readthedocs is a valid option. sphinx was designed to document python so it integrates well with pydoc and has either a familiar format or it can be customized.

That's how we're doing the OpenDCS documentation. It's also built as part of the github actions for dev feedback but readthedocs is responsible for the actual rendering and hosting.