Open phackstock opened 2 years ago
@znicholls I took a quick look at both your suggestions and they both look really good to me.
There's one slight issue which is that currently there is a README.rst
file in the root of the doc/
folder. Since this is just meant as instructions on GitHub it is not included in the docs, therefore both checks, for any warnings and excluded files currently fail.
The easiest solution would be to create another folder inside the doc/
source such as doc/source
.
Nice pickup.
I've always used docs/source
for my docs so would go with that but also happy to leave this as an issue for another day and merge here.
Hey, would indeed be nice I think to remove the warning, but keep the instructions on GitHub. If that can work, i don't really mind where that file would rest, so I'd vote for doing the easiest way there - can be done within this PR as doc/source
I guess.
Closes #12.
Adding a GitHub action to verify that the docs can be built without any errors. Runs on every PR and on pushes on
main
.Tests addedDocumentation addedExample added (in the documentation, to an existing notebook, or in a new notebook)CHANGELOG.rst
added (single line such as:(`#XX <https://github.com/iiasa/climate-assessment/pull/XX>`_) Added feature which does something
)