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

Documentation version 1.3.1 not available. #10794

Closed
MatthewFlamm opened this issue Sep 8, 2019 · 10 comments · Fixed by scipy/docs.scipy.org#29
Closed

Documentation version 1.3.1 not available. #10794

MatthewFlamm opened this issue Sep 8, 2019 · 10 comments · Fixed by scipy/docs.scipy.org#29
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org

Comments

@MatthewFlamm
Copy link
Contributor

MatthewFlamm commented Sep 8, 2019

https://docs.scipy.org/doc/scipy/reference/ points to version 1.3.0. Other x.x.1 releases have documentation here.

@tylerjereddy tylerjereddy added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label Sep 8, 2019
@tylerjereddy
Copy link
Contributor

I think we aren't too strict about uploading the x.x.1 point releases as long as the major release is linked, but yes that's likely my fault. I'm trying to help with the Nature Methods manuscript revisions & other things, but will aim to come back to this.

@MatthewFlamm
Copy link
Contributor Author

MatthewFlamm commented Sep 24, 2019

I consider documentation to be as important as the code itself. Here is one example of where there is a new feature in 1.3.1 that is totally opaque to most users because there is no published documentation.

https://github.com/scipy/scipy/blob/master/scipy/integrate/_ivp/ivp.py#L273

This is incorrect as I though I was on the 1.3.1 tag, but I was not.

@ev-br
Copy link
Member

ev-br commented Sep 24, 2019

I consider documentation to be as important as the code itself

While it's likely that you did not mean this personally, but still. Please be more nice towards the volunteer RM.

@MatthewFlamm
Copy link
Contributor Author

My comment was intended as my 2 cents on the policy on documentation not being uploaded for all releases, not a personal comment on this release itself. This is clearly not how I wrote it however, so I apologize.

I would like to amend my comment to: "It should be considered to change the policy to upload documentation for all releases, as I consider the documentation to be as important as the code itself".

Also, thank you for keeping the comments civil.

@ev-br
Copy link
Member

ev-br commented Sep 27, 2019

Tyler, do you need a hand on building/uploading the 1.3.1 docs?

@tylerjereddy
Copy link
Contributor

I'll try to get it done shortly--make dist is a bit of pain from a portability / versatility / error handling standpoint--it failed on a mac and WSL in last two days on that branch. Actually, it failed for most of my recent uploads, I just worked around the failure by making a few targets separately.

@ev-br
Copy link
Member

ev-br commented Sep 27, 2019

I still have my setup from pre-1.0 times, can check if it still works. DM me at gmail if that's helpful.

@tylerjereddy
Copy link
Contributor

Alright, I think I've uploaded the stuff properly now & the cross-linked PR to adjust the main page is open. (Real) Ubuntu works a bit better for me..

@ev-br
Copy link
Member

ev-br commented Sep 29, 2019

Thanks Tyler

@MatthewFlamm
Copy link
Contributor Author

Thanks from me as well. Sorry again for my poorly articulated comment. I really appreciate the effort that goes into maintaining this wonderful package. Keep up the good work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants