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

ReadTheDocs latest/stable are both old #579

Closed
bdice opened this issue Apr 29, 2021 · 4 comments
Closed

ReadTheDocs latest/stable are both old #579

bdice opened this issue Apr 29, 2021 · 4 comments

Comments

@bdice
Copy link
Contributor

bdice commented Apr 29, 2021

ReadTheDocs latest and stable tags appear to be stale.

The latest branch points to 0.6.1 instead of 0.7.1:
https://nbqa.readthedocs.io/en/latest/history.html

The stable branch points to 0.3.6:
https://nbqa.readthedocs.io/en/stable/history.html

I suggest pointing latest to the master branch and stable to the most recent tag (0.7.1 as of this writing). It is also possible to run RTD builds for every pull request.

Fixing this requires project permissions on ReadTheDocs. @MarcoGorelli I'd be happy to help if desired. My ReadTheDocs username is the same as my GitHub username. 👍

I noticed this because I couldn't find the new support for yapf #547 in the docs, and couldn't add a link to the README as @MarcoGorelli suggested in a comment. 😄

@MarcoGorelli
Copy link
Collaborator

Hey @bdice - thank you so much for alerting me of this! I've rebuilt the docs and added you as maintainer on ReadTheDocs

@s-weigand
Copy link
Contributor

RTD also has hooks to automatically change the default branch e.g. if a new tag was created.
I wish all those cool settings were also available via the readthedocs.yml and not only the web UI.

@bdice
Copy link
Contributor Author

bdice commented May 3, 2021

@MarcoGorelli Thank you! Also I saw you added yapf to the README -- thanks for that.

I would suggest enabling PR builds for ReadTheDocs. It shows up as a CI check and shows the docs for that pull request. It's really handy for reviewing PRs to the documentation and might be able to replace the existing CI check for doc builds.

It can be enabled here if you like the idea: https://readthedocs.org/dashboard/nbqa/advanced/

image

https://docs.readthedocs.io/en/latest/guides/autobuild-docs-for-pull-requests.html

@MarcoGorelli
Copy link
Collaborator

Thanks, done!

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

3 participants