From b909b5fc78af8be3f7bd4298857900e75925c387 Mon Sep 17 00:00:00 2001 From: Oliver Jahn Date: Tue, 18 Sep 2018 14:19:00 -0400 Subject: [PATCH 1/3] add configuration for rtd-bot --- .github/config.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .github/config.yml 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 From b1433b17daadf4641b581d8f6b10ae96da4f1df2 Mon Sep 17 00:00:00 2001 From: Oliver Jahn Date: Tue, 18 Sep 2018 14:27:10 -0400 Subject: [PATCH 2/3] Mention doc building for pull requests --- doc/contributing/contributing.rst | 6 ++++++ 1 file changed, 6 insertions(+) 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 ---------------------------------------------------------- From 74c9cd2a4949fee2b4fa3ffd4994780fbcb13539 Mon Sep 17 00:00:00 2001 From: Oliver Jahn Date: Mon, 27 Jul 2020 09:36:09 -0400 Subject: [PATCH 3/3] Trivial change to trigger Travis --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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/) +