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

--link-prefix has no effect on links to other identifiers #66

Open
mikecharles opened this issue Sep 1, 2015 · 0 comments

Comments

Projects
None yet
1 participant
@mikecharles
Copy link

commented Sep 1, 2015

When I use the --link-prefix option, all the links in the index, sub-modules list, etc. do have the link prefix, but links automatically generated from identifiers in backticks sit at the root of the server.

For example, if browse the documentation at www.example.com/example2, an identifier in the docstring like this:

"""
See `example1.file1`
"""

results in the link:

www.example.com/example1.file1.ext

These identifiers should have the same link prefix so that if you document multiple packages you can link to them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.