Skip to content

DOC: Turn SciPy references into links. - #8219

Merged
charris merged 3 commits into
numpy:masterfrom
wrwrwr:scipy-links
Oct 28, 2016
Merged

charris merged 3 commits into
numpy:masterfrom
wrwrwr:scipy-links

Conversation

@wrwrwr

@wrwrwr wrwrwr commented Oct 28, 2016

Copy link
Copy Markdown
Contributor

Added SciPy intersphinx inventory to make references clickable (for example in "See also" sections in convolve or polyfit). Some scipy.stats references also needed updating (such as those in vonmises or zipf; note that to see the effect one needs to rebuild mtrand.so before building the documentation).

@charris

charris commented Oct 28, 2016 •

Copy link
Copy Markdown
Member

Looks good. The main question I have is whether we should have links to the documentation or references to the actual importable functions. Could you make a post to the numpy mailing list and raise the topic for discussion?

@rgommers

Copy link
Copy Markdown
Member

whether we should have links to the documentation

cross-linked documentation like in this PR is what we want I'd think

or references to the actual importable functions

I'm not sure what you mean by this?

@wrwrwr

wrwrwr commented Oct 28, 2016 •

Copy link
Copy Markdown
Contributor Author

@charris Probably just my bad wording, sorry for the confusion. These are standard references to subclasses of rv_continuous or rv_discrete which are the thing to import. Intersphinx can turn them into links in the generated documentation which seems convenient.

@charris
charris merged commit f303cce into numpy:master Oct 28, 2016
@charris

charris commented Oct 28, 2016

Copy link
Copy Markdown
Member

Thanks @wrwrwr .

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.

3 participants