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

Docs "source" buttons do not go to source code for relevant function #22

Closed
kimlaberinto opened this issue Aug 23, 2021 · 1 comment · Fixed by #23
Closed

Docs "source" buttons do not go to source code for relevant function #22

kimlaberinto opened this issue Aug 23, 2021 · 1 comment · Fixed by #23

Comments

@kimlaberinto
Copy link
Contributor

kimlaberinto commented Aug 23, 2021

As mentioned in #21 (comment)

In the deployed docs, the "source" buttons that appear when you hover over functions' docstrings do not properly link to the docstring in the source code. They simply only link to the main repo URL.

Some thoughts can be found the following link to my draft PR.

@kimlaberinto
Copy link
Contributor Author

kimlaberinto commented Aug 23, 2021

When I looked at various docs/make.jl files from various prominent Julia packages, I found that none of them used the repo field in makedocs.

I checked the Documenter.jl docs, and it said this about repo in makedocs:

repo specifies a template for the "link to source" feature. If you are using GitHub, this is automatically generated from the remote.

As we are using GitHub, I believe this should be automatic so I think removing repo from makedocs will make it work, leading to my PR #23

If you have CI checks that produce a preview version of deployed docs, then we can check that version. I tried building locally but I faced other issues, where I couldn not see the "link to source code" buttons in my local builds
https://discourse.julialang.org/t/documenter-im-not-seeing-source-hover-buttons-in-my-local-docs-build-how-can-i/66823

@kimlaberinto kimlaberinto changed the title Docs "source" buttons do not to source code for relevant function Docs "source" buttons do not go to source code for relevant function Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant