Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/requirements/docs.in

21 lines
621 B
Plaintext
Raw Normal View History

requirements: Rename requirements files. This commit renames various source requirements files like `dev.txt`, `mypy.txt` etc to `dev.in`, `mypy.in` etc and various locked requirements files like `dev_lock.txt`, `mypy_lock.txt` etc to `dev.txt`, `mypy.txt` etc. This will help in emphasizing to the user that *.in are actually input to `update-locked-requirements` tool which should be run after updating any of these.
2017-11-17 02:41:06 +01:00
# 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
requirements: Upgrade sphinx from 1.8.3 to 1.8.4.
2019-03-06 17:08:06 +01:00
sphinx==1.8.4
requirements: Upgrade sphinx-rtd-theme from 0.4.2 to 0.4.3.
2019-03-06 10:12:43 +01:00
sphinx-rtd-theme==0.4.3
requirements: Rename requirements files. This commit renames various source requirements files like `dev.txt`, `mypy.txt` etc to `dev.in`, `mypy.in` etc and various locked requirements files like `dev_lock.txt`, `mypy_lock.txt` etc to `dev.txt`, `mypy.txt` etc. This will help in emphasizing to the user that *.in are actually input to `update-locked-requirements` tool which should be run after updating any of these.
2017-11-17 02:41:06 +01:00
# Needed to build markdown docs
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-16 03:14:05 +02:00
recommonmark==0.5.0
requirements: Rename requirements files. This commit renames various source requirements files like `dev.txt`, `mypy.txt` etc to `dev.in`, `mypy.in` etc and various locked requirements files like `dev_lock.txt`, `mypy_lock.txt` etc to `dev.txt`, `mypy.txt` etc. This will help in emphasizing to the user that *.in are actually input to `update-locked-requirements` tool which should be run after updating any of these.
2017-11-17 02:41:06 +01:00
Revert "docs: Update dependencies for docs." This reverts commit 4303b42abdf14c2d7d17b4e9477455faff0cb845. This appears to have broken various documentation links to e.g. README.md on GitHub.
2019-03-06 18:55:51 +01:00
# Upgrading to the latest version of CommonMark breaks the
# compatibility with recommonmark. See
# https://github.com/rtfd/recommonmark/issues/24
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-16 03:14:05 +02:00
CommonMark==0.9.0