docs: Link to Definition #47920
Merged
docs: Link to Definition #47920
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
grahamc
commented
Oct 5, 2018
| in pkgs.writeText | ||
| "locations.xml" | ||
| '' | ||
| <section xmlns="http://docbook.org/ns/docbook" |
There was a problem hiding this comment.
This file emits a big ol' XML doc which is xincluded by ID:
<section><title>lib.asserts.assertOneOf</title>
<para xml:id="lib.asserts.assertOneOf">
Located at
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/e1c892c29340157e921c5bd2a2489201fa5d2821/lib/asserts.nix#L38">lib/asserts.nix:38</link>
in <literal><nixpkgs></literal>.
</para>
</section>
<section><title>lib.attrsets.attrByPath</title>
<para xml:id="lib.attrsets.attrByPath">
Located at
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/e1c892c29340157e921c5bd2a2489201fa5d2821/lib/attrsets.nix#L24">lib/attrsets.nix:24</link>
in <literal><nixpkgs></literal>.
</para>
</section>
Hydra passes the full revision in to the input, which we pass through. If we don't get this ,we try to get it from other sources, or default to master which should have the definition in a close-ish location. All published docs should have theURL resolve properly, only local hackers will have the link break.
grahamc
force-pushed
the
link-to-definition
branch
from
da3aec4
to
5daee73
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
Check out this here: http://gsc.io/nixpkgs-docs/html/#sec-functions-library
click that lib/asserts.nix bit and see that 馃敟 馃槏 link to https://github.com/NixOS/nixpkgs/blob/e1c892c29340157e921c5bd2a2489201fa5d2821/lib/asserts.nix#L21 ^.^
Pretty sure the abstraction of the revision finder will cause local users to not rebuild it unnecessarily.
Things done
sandboxinnix.confon non-NixOS)nix-shell -p nox --run "nox-review wip"./result/bin/)nix path-info -Sbefore and after)