Closed vtnate closed 4 months ago
This is a simple documentation interface, using the Material theme for MkDocs.
Using Mkdocs enables us to work in markdown and avoid the complication of sphinx/rst.
This publishes documentation to https://nrel.github.io/ThermalNetwork/ via a GitHub Actions workflow when changes to the docs folder are merged to main branch. All docs are written entirely in markdown and there is a yaml config file in the project root.
main
When developing, we can serve docs locally and it updates the live draft with every save.
mkdocs serve
http://127.0.0.1:8000/
There is a LOT of customization we can do with MkDocs - this is very basic right now.
Any background context you want to provide?
This is a simple documentation interface, using the Material theme for MkDocs.
Using Mkdocs enables us to work in markdown and avoid the complication of sphinx/rst.
What does this PR accomplish?
This publishes documentation to https://nrel.github.io/ThermalNetwork/ via a GitHub Actions workflow when changes to the docs folder are merged to
mainbranch. All docs are written entirely in markdown and there is a yaml config file in the project root.How should this be manually tested?
When developing, we can serve docs locally and it updates the live draft with every save.
mkdocs servehttp://127.0.0.1:8000/There is a LOT of customization we can do with MkDocs - this is very basic right now.
What are the relevant tickets?
Screenshots (if appropriate)