readthedocs points to an unreleased version
See original GitHub issueI spent the better part of this day trying to figure out why my installation of marshmallow didn’t have the constants INCLUDE, RAISE, etc. After some digging, I figured out what the problem was: the default readthedocs link points to documentation for the yet unreleased dev version of the package.
I think this should definitely be fixed or the docs should state the discrepancy in a more visible manner. At the very least, it should be made clear that the $ pip install -U marshmallow --pre
under the Get It Now
section` does not point to the same version which the documents describe.
Issue Analytics
- State:
- Created 5 years ago
- Reactions:1
- Comments:8 (8 by maintainers)
Top Results From Across the Web
Versioned Documentation - Read the Docs
Read the Docs supports multiple versions of your repository. On initial import, we will create a latest version. This will point at the...
Read more >Read the Docs Documentation
Note: Read the Docs follows some rules to decide whether to create a stable version pointing to your new branch or.
Read more >ReadTheDocs site with 2 long-term version branches
Currently, if someone goes to https://foo.readthedocs.io/en/latest , they get the 2.x docs, but after 1 year I want to flip that to point...
Read more >Solved: How do you reference Fix versions - Next unrelease...
Solved: I want to set my rule to add the Next unreleased version instead of setting it to the Next unreleased version but...
Read more >Versioning - Docusaurus
Think about it before starting to version your documentation - it can ... the current version and latest version will both be point...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Having the default (latest) point to a pre-release version can also cause confusion. It would be nice if this was communicated more clearly. Jasmine uses a version index as their docs landing page.
https://jasmine.github.io/pages/docs_home.html
Ideally, there would also be a way to display the docs for untagged
dev
, for a final verification before releasing, but it is not that important for pre-release versions.