Skip to content

Test doc building for pull requests #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jahn wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Test doc building for pull requests #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b909b5f
add configuration for rtd-bot
jahn Sep 18, 2018
b1433b1
Mention doc building for pull requests
jahn Sep 18, 2018
74c9cd2
Trivial change to trigger Travis
jahn Jul 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
rtd:
project: MITgcm-jahn
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
- Access the new (incomplete) documentation [here](http://mitgcm.readthedocs.io/en/latest/)

6 changes: 6 additions & 0 deletions doc/contributing/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------------------------------

Expand Down