Skip to content
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.

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

Basic docs for numpydoc #118

Merged
merged 9 commits into from
Oct 22, 2017
Merged

Basic docs for numpydoc #118

merged 9 commits into from
Oct 22, 2017

Conversation

jnothman
Copy link
Member

@jnothman jnothman commented Oct 22, 2017

Apologies if my conf.py is naively constructed from a mix of the Sphinx generated and numpy's.

Fixes #66?

@pv
Copy link
Member

pv commented Oct 22, 2017

Add it to travis build?

@jnothman
Copy link
Member Author

If there is consensus that it's worth hosting numpydocs separate from numpy, how do you want to handle publishing?

@pv
Copy link
Member

pv commented Oct 22, 2017

I think readthedocs is the minimum effort solution, automatic doc builds etc. without hassle.
(The builds on travis would only be for testing the doc build stays in working condition.)

EDIT: I think it's not controversial to host separate docs, when the repository is separate and and has separate versioning and pypi packages.

@jnothman
Copy link
Member Author

It's also the subject of #66

@jnothman
Copy link
Member Author

So you just want an exit status check in travis? Sure.

Rendered
========

.. automodule:: example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't seem to import this module on travis, maybe add to sys.path in config?

@pv
Copy link
Member

pv commented Oct 22, 2017

Also, the configuration options are probably best explained in just one place, so maybe drop from README.rst?

otherwise lgtm

@pv
Copy link
Member

pv commented Oct 22, 2017

needs rebase

@pv pv merged commit 349adb2 into numpy:master Oct 22, 2017
@pv
Copy link
Member

pv commented Oct 22, 2017

lgtm, I'll just merge and if there's something to do we can iterate.
I created the readthedocs project --- let me know your account name to get admin rights there.

@jnothman
Copy link
Member Author

Great! I'm jnothman there too.

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.

2 participants