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

DOC: actually produce docs for as_strided #9039

Merged
merged 1 commit into from
May 5, 2017

Conversation

eric-wieser
Copy link
Member

No description provided.

@mhvk
Copy link
Contributor

mhvk commented May 2, 2017

as_strided is not in the top-level name space (somewhat on purpose, I think). Given that, will this be in the right place?

@eric-wieser
Copy link
Member Author

Good point. I guess this is a type of local build I can test, since it doesn't depend on the python source tree

@@ -41,6 +41,7 @@ Indexing-like operations
diag
diagonal
select
as_strided
Copy link
Member

Choose a reason for hiding this comment

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

I think this needs to be lib.stride_tricks.as_strided.

But anyways, yes, you can definitely test this with a local docs build (cd doc followed by make html).

Copy link
Member Author

Choose a reason for hiding this comment

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

make html doesn't work on windows, because mkdir -p means something different

Copy link
Member Author

Choose a reason for hiding this comment

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

But sphinx-build works fine - and your suggestion is correct. Fixed!

Copy link
Member

Choose a reason for hiding this comment

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

Ah, that's a bummer. I tried configuring a doc build on ReadTheDocs (see readthedocs.org/projects/numpy) but have not been able to get numpy building yet. I'm glad you figured out another way :)

@charris
Copy link
Member

charris commented May 5, 2017

Works for me. Thanks Eric.

@charris charris merged commit 0c33b29 into numpy:master May 5, 2017
@eric-wieser
Copy link
Member Author

eric-wieser commented May 5, 2017

Out of curiousity - is there a cronjob to produce https://docs.scipy.org/doc/numpy-dev/, or is that a manual endeavor? Would be good to have some way to sanity check formatting before a release, even if it's after a PR merge.

@charris
Copy link
Member

charris commented May 5, 2017

@eric-wieser Scipy has infrastructure for checking documentation for coverage, but I don't know if it allows viewing the results. We should take a look at it in any case, I believe it is the CircleCI test.

@rgommers Comment?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants