Commit Graph

6 Commits

Author SHA1 Message Date
Tim Abbott
d4893dfcbc docs: Make API endpoint docs link to materials on REQ.
This should help avoid bugs like the one in the previous commit.
2019-04-23 11:31:19 -07:00
Tim Abbott
abc7a00d35 Revert "docs: Update .html links to .md."
This doesn't work without the CommonMark upgrade.

This reverts commit c87893feea.
2019-04-05 17:58:54 -07:00
Samuel Searles-Bryant
c87893feea docs: Update .html links to .md.
Sphinx/ReadTheDocs supports automatically translating links written as
to `.md` files to point to the corresponding `.html` files, so this
migration does not change the resulting HTML output in ReadTheDocs.
But it does fix apparent broken links on GitHub.

This doesn't prevent people from reading the documentation on GitHub
(so doesn't mitigate the fact that some rtd-specific syntax does not
render properly on GH), but it will prevent us from getting erroneous
issues reported about the hyperlinks not working.

Fixes: #11087.
2019-04-05 17:16:25 -07:00
Kevin Lin
7f075e0da2 docs: Fix path to REST endpoints index.
The path in the tutorial was incorrect.
2018-10-15 12:48:09 -07:00
Tim Abbott
ce4f00bd84 docs: Attempt to clarify the REST API writing docs. 2018-06-04 16:01:07 -07:00
Eeshan Garg
371cacde35 docs: Add a guide on how to document REST API endpoints. 2018-06-04 15:27:49 -07:00