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 to sourcecode for modules of other Packages #1273

Closed
Datseris opened this issue Mar 24, 2020 · 3 comments
Closed

Link to sourcecode for modules of other Packages #1273

Datseris opened this issue Mar 24, 2020 · 3 comments

Comments

@Datseris
Copy link
Contributor

Hi, in DynamicalSystems.jl 4 other Julia packages are loaded as modules, and the docs are being created. Here is how our make file looks like:

https://github.com/JuliaDynamics/DynamicalSystems.jl/blob/master/docs/make.jl

All functions that are expanded in @docs blocks come from modules that are re-exported by dynamical systems. We use Reexport to do this at the moment.

Unfortunately, the nice button "source" dissapears from the expanded docstrings. See e.g.:

https://juliadynamics.github.io/DynamicalSystems.jl/dev/chaos/lyapunovs/#ChaosTools.lyapunovs

Is it possible to restore this button to point at the source from another repo?

@goerz
Copy link
Member

goerz commented Feb 17, 2023

I've had the same problem with QuantumControl, and I finally figured out that Documenter shows the Source button if and only if the file with the source is in a git repository. This means I've had to install all the packages that I want to include docstrings for via Pkg.develop in the CI run that generates the documentation (which clones them into ~/.julia/dev` and thus allows Documenter to figure out the link to their original Github repo).

It would probably be good if this was explained in Documenter's documentation somewhere.

@mortenpi
Copy link
Member

I think this will get addressed together with #1975.

@odow
Copy link
Collaborator

odow commented Nov 2, 2023

Documenter 1.0 has a new remotes keyword exactly for this. It just needs some better documentation, so closing in favor of #2242.

@odow odow closed this as completed Nov 2, 2023
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

No branches or pull requests

4 participants