zulip/docs/contributing
David Rosa 0d52d24d64 docs: pip upgrade recommonmark and CommonMark
Summary:
- recommonmark: 0.4.0 -> 0.5.0
- CommonMark: 0.5.4 -> 0.9.0
- Fixed links getting their .md file extension cut off
- Supressed 262 new warnings

Details:
Appended #anchors to markdown github links as a workaround to
recommonmark 0.5.0 cutting off the ".md" part from them.
Sphinx build would fail as follows

[documentation_crawler] ERROR: Please check link:
<404 https://github.com/zulip/zulipbot/blob/master/.github/CONTRIBUTING>
<404 https://github.com/zulip/zulip/blob/master/requirements/README>
<404 https://github.com/zulip/python-zulip-api/blob/master/zulip_bots/README>

sphinx build would also log a "WARNING: None:any reference target not found"
for every link ending in .html
So a good temporary solution is to suppress all warnings with the method suggested here:
https://stackoverflow.com/questions/37359407/suppress-warnings-for-unfound-references-with-default-role-any-in-sphinx

A better solution would be to edit all links ending .html and use .md instead;
which would also solve PR #11719.

Fixes #11395.
2019-08-15 22:41:40 -07:00
..
accessibility.md developer docs: Refer to 'zulipbot add' instead of 'zulipbot label'. 2018-09-21 12:16:39 -07:00
bug-reports.md docs: Reorganize developer docs to improve navigation. 2017-11-16 09:45:08 -08:00
chat-zulip-org.md Revert "docs: Update .html links to .md." 2019-04-05 17:58:54 -07:00
code-reviewing.md Revert "docs: Update .html links to .md." 2019-04-05 17:58:54 -07:00
code-style.md templates: Rename *.handlebars ↦ *.hbs and - ↦ _. 2019-07-12 21:11:03 -07:00
gsod-ideas.md docs: Move tutorials/documenting-api-endpoints to documentation/api. 2019-05-30 11:12:25 -07:00
index.rst docs: Move mypy documentation from contributing to testing. 2018-12-16 21:52:53 -08:00
summer-with-zulip.md docs: Add link to linkedin to summer-with-zulip. 2019-06-05 17:03:24 -07:00
version-control.md docs: Update links to skip help.github.com redirects. 2019-02-26 11:03:08 -08:00
zulipbot-usage.md docs: pip upgrade recommonmark and CommonMark 2019-08-15 22:41:40 -07:00