juliadocs / documenterinterlinks.jl Goto Github PK
View Code? Open in Web Editor NEWA plugin for Documenter.jl that enables linking between projects
Home Page: http://juliadocs.org/DocumenterInterLinks.jl/
License: MIT License
A plugin for Documenter.jl that enables linking between projects
Home Page: http://juliadocs.org/DocumenterInterLinks.jl/
License: MIT License
I am working a bit on keyword arguments and mentioning their defaults.
I noticed that [`Example`](@ref)
is rendered nicely on REPL, while @extref
ones are not. Could this be fixed by defining a certain show Method?
Example:
If we have ManifoldsBase.jl
in the Documenter plugin like
links = InterLinks(
"ManifoldsBase" => ("https://juliamanifolds.github.io/ManifoldsBase.jl/stable/"),
)
and define somewhere in a doctoring
"""
* `X = ` [`zero_vector`](@extref `ManifoldsBase.zero_vector-Tuple{AbstractManifold, Any}`)`(M,p)` :
specify a memory internally to store the gradient
"""
function foo end
its docs on help?> foo
look like
• X = zero_vector (@extref `ManifoldsBase.zero_vector-Tuple{AbstractManifold, Any}`)(M,p): specify a memory internally to store the gradient
while I would prefer them to look like (as is done for @ref
s
• X = zero_vector (M,p): specify a memory internally to store the gradient
(zero_vector
is light blue since it is a link in REPL)
Hello!
Looking at the InterLinks
docstring (the link in the second paragraph of the readme is broken BTW), it's not clear if
links = InterLinks(
"project1" => "local/path/to/inv",
)
would work or not. If you could clarify this, that would be great 🙂
This is something I'm interested in since I'm currently restructuring a sextet of related packages of mine into a mono-repo, with each package (and their docs
subfolder + inventory) in a subfolder of the main repo.
This issue is used to trigger TagBot; feel free to unsubscribe.
If you haven't already, you should update your TagBot.yml
to include issue comment triggers.
Please see this post on Discourse for instructions and more details.
If you'd like for me to do this for you, comment TagBot fix
on this issue.
I'll open a PR within a few hours, please be patient!
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.