-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Fix Edit links on stable versions #3238
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
Conversation
Found tag to hash conversion code in This bug is a result of historic Git design, which treats annotated tags and non-annotated tags differently - see |
Thanks @techtonik. Let us know when this is ready to review! Also, if there were any steps that would have been clearer in the documentation to help you and future people touching this part of the code out, perhaps you could add a note in the docs along with this PR. For instance, a section on conversion steps would be good. |
@RichardLitt it is now ready to review. About documentation. #3240 is the proposal how to make docs more logical, which make architecture page the main entrypoint. Because I could not discover any other entrypints. Even though I send the patch, I still haven't got the big picture how RTD works. The surprising thing was to learn that build process is handled by Django application. From architecture page I expected to learn how the build process is started, who starts it, how to test the build step without Django. Who reads the repo metadata - GitHub plugin for Sphinx or somebody else? Where does this metadata passed? Is there an intermediary step where all metadata between steps can be statically explored, maybe in Travis logs. For me, a good example of architecture docs is here - it describes simple yaml converter in sufficient detail to start working on the code right away without much experiments and preliminary test. And to make matters worse - the showstopper why I haven't fixed this 6 months ago is here #1820 (comment) - run into some Django magic, but I don't use Django, so I didn't know where to go next. |
This should return dereferenced hash that points to commit
Closing in favour of #3302. |
This should fix at least #1637, #1820 and other duplicates.
The root cause is that RTD incorrectly converts version tag into git commit hash.
It was hard to figure out what's the cause, because: