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

Provide the source file name to the JS in readthedocs theme #721

Merged
merged 1 commit into from Sep 22, 2015

Conversation

Projects
None yet
2 participants
@gregmuellegger
Contributor

gregmuellegger commented Sep 7, 2015

readthedocs.org needs the file name in order to identify the correct source file to link to the same file in other versions of the same documentation or to the source on GitHub.

See rtfd/readthedocs.org#1480 for more information.

Provide the source file name to the JS in readthedocs theme
readthedocs.org needs the file name in order to identify the correct source
file to link to the same file in other versions of the same documentation or
to the source on GitHub.

Related rtfd/readthedocs.org#1480

gregmuellegger added a commit to rtfd/readthedocs.org that referenced this pull request Sep 7, 2015

Fix links to other versions in mkdocs documentation footer
The problem was that we didn't had access to the correct page name (the
relative path to the source file without the .md suffix).

In order for this fix to work mkdocs needs to integrate mkdocs/mkdocs#721 and
create a new release.

gregmuellegger added a commit to rtfd/readthedocs.org that referenced this pull request Sep 7, 2015

Fix links to other versions in mkdocs documentation footer
The problem was that we didn't had access to the correct page name (the
relative path to the source file without the .md suffix).

In order for this fix to work mkdocs needs to integrate mkdocs/mkdocs#721 and
create a new release.
@d0ugal

This comment has been minimized.

Member

d0ugal commented Sep 8, 2015

Looks fine to me. Was mkdocs_page_url not useful? We can remove that if it didn't help.

@gregmuellegger

This comment has been minimized.

Contributor

gregmuellegger commented Sep 10, 2015

Hi, the mkdocs_page_url was kind of the right thing, but not completely. We use the input_path now by splitting away the file suffix. And what is left is the value we need in readthedocs.

With the page url we would propably be able to get to the same value by stripping the leading and trailing slash, but that feels to dirty and might break if mkdocs once decides that it will append index.html to every URL or anything similiar.

You can remove the mkdocs_page_url if you want, but I assume it won't hurt to keep it around.

d0ugal added a commit that referenced this pull request Sep 22, 2015

Merge pull request #721 from gregmuellegger/fix-rtd-page-name
Provide the source file name to the JS in readthedocs theme

@d0ugal d0ugal merged commit 3c6a66b into mkdocs:master Sep 22, 2015

3 checks passed

codecov/project 93.59% (target 90.00%)
Details
continuous-integration/appveyor AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@d0ugal

This comment has been minimized.

Member

d0ugal commented Sep 22, 2015

Sorry for the delay in getting back to this. Thanks - I'll try and get a release out soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment