mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 04:52:12 +00:00
0d52d24d64
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.
21 lines
621 B
Plaintext
21 lines
621 B
Plaintext
# This is used by ReadTheDocs to install dependencies, so it's
|
|
# valuable to keep this file as just the dependencies for our
|
|
# documentation.
|
|
|
|
# After editing this file, you MUST afterward run
|
|
# /tools/update-locked-requirements to update requirements/dev.txt
|
|
# and requirements/docs.txt.
|
|
# See requirements/README.md for more detail.
|
|
|
|
# Needed to build RTD docs
|
|
sphinx==1.8.4
|
|
sphinx-rtd-theme==0.4.3
|
|
|
|
# Needed to build markdown docs
|
|
recommonmark==0.5.0
|
|
|
|
# Upgrading to the latest version of CommonMark breaks the
|
|
# compatibility with recommonmark. See
|
|
# https://github.com/rtfd/recommonmark/issues/24
|
|
CommonMark==0.9.0
|