diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000000..e4bed34733 --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,2 @@ +rtd: + project: MITgcm-jahn diff --git a/README.md b/README.md index a18ed026b6..148bd83def 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,5 @@ MIT General Circulation Model master code and documentation. The main MITgcm web We are currently in the process of transferring the documentation to Read the Docs. - Access the old (complete) documentation [here](http://mitgcm.org/public/r2_manual/final/) -- Access the new (incomplete) documentation [here](http://mitgcm.readthedocs.io/en/latest/) \ No newline at end of file +- Access the new (incomplete) documentation [here](http://mitgcm.readthedocs.io/en/latest/) + diff --git a/doc/contributing/contributing.rst b/doc/contributing/contributing.rst index 28b69dbc7f..b0d5857557 100644 --- a/doc/contributing/contributing.rst +++ b/doc/contributing/contributing.rst @@ -108,6 +108,12 @@ If you prefer, you can rebase rather than merge in the final step above; just be careful regarding your rebase syntax! +**8.** If your pull request modifies the documentation, rtf-bot will +automatically build the updated docs and a link to them will be added +to the pull request. + + + Detailed guide for those less familiar with Git and GitHub ----------------------------------------------------------