This is an archive of the discontinued LLVM Phabricator instance.

[docs] add cross-reference
ClosedPublic

Authored by scott-0 on Mar 31 2015, 7:34 AM.

Details

Reviewers
rengolin
Summary

Add a cross-reference from Phabricator to Commit Messages as requested by Renato.

Diff Detail

Event Timeline

scott-0 updated this revision to Diff 22956.Mar 31 2015, 7:34 AM
scott-0 retitled this revision from to [docs] add cross-reference.
scott-0 updated this object.
scott-0 edited the test plan for this revision. (Show Details)
scott-0 added a reviewer: rengolin.
scott-0 added a subscriber: Unknown Object (MLST).
rengolin edited edge metadata.Mar 31 2015, 7:37 AM

Will that link to the right doc?

It did when I tried it with sphinx, but it is my first experience creating a ReST link.

So, to test, go into the docs directory and type:

$ sphinx-build -b html -d _build/doctrees . _build/html <DOC>.rst

This will generate the doc as it should, so you open the file in _build/html/<DOC>.html.

If your doc refers to another, you better generate both, so you can follow the link.

Yes, that's essentially what I did before I created the review. [I used 'make -f Makefile.sphinx' which does the same thing.]

The link works for me.

rengolin accepted this revision.Mar 31 2015, 8:03 AM
rengolin edited edge metadata.

LGTM, Thanks! :)

This revision is now accepted and ready to land.Mar 31 2015, 8:03 AM

Thanks! Committed in r233699.

scott-0 closed this revision.Apr 1 2015, 3:06 AM

Closing