Link to the docdir of the remote repo in non-rtd themes for mkdocs #5513
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently we depend on https://github.com/mkdocs/mkdocs/blob/d101522aa197aaa212f1424180d693dd5d497875/mkdocs/themes/readthedocs/base.html#L35-L40 which is only available in the rtd theme. For non-rtd themes we are generating a link like `https://github.com/mkdocs/mkdocs/blob/master/docs/.md`
stsewd
commented
Mar 20, 2019
readthedocs/builds/models.py
Outdated
| @@ -360,6 +358,10 @@ def get_github_url( | |||
| return '' | |||
| repo = repo.rstrip('/') | |||
|
|
|||
| if not filename: | |||
| filename = '' | |||
There was a problem hiding this comment.
We can receive filename as None or empty string, I can search for all the calls and make sure we always receive a string.
There was a problem hiding this comment.
I'm going to do that actually, we only use this in the footer api I think
Seems reasonable 👍 |
ericholscher
approved these changes
Mar 20, 2019
Co-Authored-By: stsewd <santos_g@outlook.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently we depend on
https://github.com/mkdocs/mkdocs/blob/d101522aa197aaa212f1424180d693dd5d497875/mkdocs/themes/readthedocs/base.html#L35-L40
which is only available in the rtd theme.
For non-rtd themes we are generating a link like
https://github.com/mkdocs/mkdocs/blob/master/docs/.mdI'm proposing the solution of just linking to the docsdir
https://github.com/mkdocs/mkdocs/blob/master/docs/Another option is just to link to the repo, and only show the
view onlink :)What do you think?
Also, looks like we can refactor this code, let me know if you feel like something that can be done here or we can create an issue later.