Skip to content

Add version to style guide #333

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
jepperaskdk opened this issue Oct 9, 2021 · 5 comments
Closed

Add version to style guide #333

jepperaskdk opened this issue Oct 9, 2021 · 5 comments

Comments

@jepperaskdk
Copy link

Hi,
When viewing this page for the style guide: https://numpydoc.readthedocs.io/en/latest/format.html
It would be great if it listed the actual version, rather than just "latest". E.g. it mentions some versions, like: "For example, the Yields section was added in numpydoc 0.6.", but I'm unclear what the current version is (that I'm viewing).

Thanks in advance

@rgommers
Copy link
Member

rgommers commented Oct 9, 2021

Good question. There's a version dropdown in the standard ReadTheDocs format, but the problem is that we do not have builds for releases:

image

So the task here is to update the RTD config to build for tags, so they show up at https://readthedocs.org/projects/numpydoc/versions/

@rgommers rgommers added the task label Oct 9, 2021
@mattip
Copy link
Member

mattip commented Oct 9, 2021

update the RTD config to build for tags

Who has access to the RTD config page at https://readthedocs.org/projects/numpydoc//edit/ ?

@larsoner
Copy link
Collaborator

I do not, happy to be added if someone has permissions -- I'm guessing @rgommers ?

@rgommers
Copy link
Member

You have access @larsoner (note there's a typo in the link above, double slash before edit). Current maintainers:

    pv
    stefanv
    rgommers
    jnothman
    larsoner

@mattip I can add you if you send me your username.

I have added a rule to build all tags, and manually triggered v1.1.0, v1.0.0 and stable (and it worked).

@mattip
Copy link
Member

mattip commented Oct 10, 2021

I can add you if you send me your username

I am mattip there as well, thanks.

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

No branches or pull requests

4 participants