Skip to content

Add numpydoc for rtd#40

Merged
harpolea merged 1 commit intopython-hydro:masterfrom
IanHawke:rtd
Nov 1, 2018
Merged

Add numpydoc for rtd#40
harpolea merged 1 commit intopython-hydro:masterfrom
IanHawke:rtd

Conversation

@IanHawke
Copy link
Copy Markdown
Contributor

@IanHawke IanHawke commented Jul 4, 2018

This is the only change needed to auto-build the docs on RTD. On RTD under "Advanced Settings" I also pointed it at the requirements file and set the interpreter to CPython3.X (did this before checking they were needed, so they might not be) and the resulting docs are at https://pyro2-rtd-fork.readthedocs.io/en/rtd/ .

This addresses issue #37 which may link to issue #38 .

@zingale
Copy link
Copy Markdown
Collaborator

zingale commented Oct 31, 2018

@harpolea can you review this?

@zingale zingale requested a review from harpolea October 31, 2018 19:58
@zingale
Copy link
Copy Markdown
Collaborator

zingale commented Nov 1, 2018

so does this mean the docs will automagically appear on rtd?

@harpolea
Copy link
Copy Markdown
Collaborator

harpolea commented Nov 1, 2018

Someone with the correct permissions (I think collaborators/organisation members should be ok, not just owners) will need to log in to read the docs and tell it to build the repo, but after that yes it should magically build on rtd

@harpolea harpolea merged commit 907e329 into python-hydro:master Nov 1, 2018
@harpolea harpolea mentioned this pull request Nov 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants