Skip to content

Release Notes Issues not Linked #842

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

Closed
tvaught opened this issue Mar 1, 2012 · 4 comments
Closed

Release Notes Issues not Linked #842

tvaught opened this issue Mar 1, 2012 · 4 comments
Labels

Comments

@tvaught
Copy link
Contributor

tvaught commented Mar 1, 2012

The release notes have a nice reference to the issue addressed by each bullet, but they're not linked to the actual issue. In my quick scan, I didn't see an easy way to mark this up in the release notes rst. You can use brute force to do it with something like:

[[[ - Add to_clipboard function to pandas namespace for writing objects to
the system clipboard (#774 <http://github.com/pydata/pandas/issues/774>_) ]]]

If it won't mess up the docs, I can add these links to the rst. But, I wanted to check first to see if this anyone knew of a simpler method or whether this would cause problems with the Sphinx stuff.

Ideas?

@takluyver
Copy link
Contributor

There's a Sphinx extension to do this - we use it for IPython: https://github.com/ipython/ipython/blob/master/docs/sphinxext/github.py

@tvaught
Copy link
Contributor Author

tvaught commented Mar 1, 2012

Ahh, I didn't look far enough. Looks like the prior release notes found in pandas/doc/source/whatsnew/v0.7.0.txt uses the markup GH220_ for example.

I see how the includes work for Sphinx, but I don't see how the v.0.x.x.txt files get put together in the RELEASE.rst? Is this a manual process?

@adamklein
Copy link
Contributor

We've been keeping RELEASE.rst manually and just mention the issues like #xxx ... we've really only take care to cross-link in the whatsnew rst docs, which make it into the html documentation, using the markup you mention -

@ghost
Copy link

ghost commented Dec 14, 2012

closed via 145d196

@ghost ghost closed this as completed Dec 14, 2012
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants