Commit Graph

30 Commits

Author SHA1 Message Date
Anders Kaseorg 672358c5da docs: Migrate from recommonmark to MyST-Parser.
Recommonmark is no longer maintained, and MyST-Parser is much more
complete.

https://myst-parser.readthedocs.io/

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-19 00:53:32 -07:00
Anders Kaseorg 61e1e38a00 requirements: Upgrade Python requirements.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-06-07 17:57:51 -07:00
Anders Kaseorg 768f9f93cd docs: Capitalize Markdown consistently.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 10:23:06 -07:00
David Rosa 9545569dca docs: Upgrade recommonmark to 0.6.0, fixing issues.
- recommonmark: 0.5.0 -> 0.6.0
- Fixed build TypeError: sequence item 1: expected str instance, NoneType found
  caused by recommonmark/parser.py erroring on a newline character.
- Removed deprecated code in conf.py that was causing warning messages
- Updated conf.py according to instructions for Sphinx-1.4 or newer
https://github.com/readthedocs/recommonmark/blob/master/README.md#getting-started
https://www.sphinx-doc.org/en/master/usage/markdown.html

This commit is also relevant to PR #13232.
2019-10-02 12:29:24 -07:00
Anders Kaseorg ec9bf6576a requirements: Remove unnecessary version bounds from *.in.
This makes no changes to the locked versions in *.txt, but it reduces
duplicate information and gives us sane workflows for

* upgrading packages: remove some or all lines from *.txt and re-run
  `update-locked-requirements`;
* marking packages as intentionally held back: add a version bound
  to *.in with an explanatory comment.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-09-23 13:23:58 -07:00
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
Anders Kaseorg 0555007bd0 requirements: Remove unused dependencies.
* backports-abc: For old Python versions.
* backports.ssl-match-hostname: For old Python versions.
* docopt: Has never been used directly.
* gitdb: Has never been used directly.
* ndg-httpsclient: No longer used by requests ≥ 2.12.1.
* pycrypto: Has never been used directly.
* smmap: Has never been used directly.
* typing: For old Python versions.
* typing_extensions: For old Python versions.

PROVISION_VERSION is not bumped because these were already unused
since at least the last major bump.

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-07-10 15:44:50 -07:00
Anders Kaseorg 51b5188299 requirements: Delist recursive dependencies from *.in not used directly.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-07-10 15:44:50 -07:00
Tim Abbott dee2de91a9 Revert "docs: Update dependencies for docs."
This reverts commit 4303b42abd.

This appears to have broken various documentation links to
e.g. README.md on GitHub.
2019-03-06 09:55:51 -08:00
Vishnu Ks 65d0b5d501 requirements: Upgrade sphinx from 1.8.3 to 1.8.4. 2019-03-06 09:31:24 -08:00
Vishnu Ks 089b31e88a requirements: Upgrade sphinx-rtd-theme from 0.4.2 to 0.4.3. 2019-03-06 09:31:24 -08:00
Samuel Searles-Bryant 4303b42abd docs: Update dependencies for docs.
This updates recommonmark so that relative links to .md files will
correctly be converted to links to html pages by Sphinx/ReadTheDocs.
This was repoprted in https://github.com/rtfd/recommonmark/issues/89

This will allow us to in a future commit use relative links to .md
files so all of the hyperlinks work both on ReadTheDocs and on GitHub.
2019-03-06 09:29:21 -08:00
Vishnu Ks d9781ec46d requirements: Upgrade Sphinx to 1.8.3. 2019-01-07 10:30:49 -08:00
Vishnu Ks c4b197cd4f requirements: Upgrade Sphinx to 1.8.2. 2018-11-12 15:27:26 -08:00
Vishnu Ks 8f5cbb5c8c requirements: Upgrade typing to 3.6.6. 2018-11-12 15:27:26 -08:00
Vishnu Ks 1444fb8870 requirements: Upgrade sphinx-rtd-theme to 0.4.2. 2018-11-12 15:27:26 -08:00
Vishnu Ks 90491692b7 requirements: Upgrade imagesize to 1.1.0. 2018-11-09 10:17:55 -08:00
Vishnu Ks 1d11fc578e requirements: Upgrade albaster to 0.7.12. 2018-11-09 10:17:55 -08:00
Vishnu Ks 8b857db5ae requirements: Upgrade sphinx-rtd-theme to 0.4.1. 2018-07-30 10:06:23 -07:00
Vishnu Ks ec5fad4cac requirements: Upgrade Sphinx to 1.7.6. 2018-07-30 10:06:23 -07:00
Vishnu Ks a8bd83cbd6 requirements: Upgrade alabaster to 0.7.11.
A bug fix and some new features like showing next
and previous links at the bottom and top of the
page content.
2018-07-30 10:06:23 -07:00
Vishnu Ks e6ce781006 requirements: Upgrade sphinx-rtd-theme to 0.3.1. 2018-05-03 20:39:56 -07:00
Vishnu Ks 1eaaecb69a requirements: Upgrade Sphinx to 1.7.4. 2018-05-03 20:39:56 -07:00
Vishnu Ks ab81d8361e requirements: Upgrade Sphinx to 1.7.2. 2018-04-01 14:24:00 -07:00
Vishnu Ks eeb454df31 requirements: Upgrade imagesize to 1.0.0. 2018-04-01 14:23:55 -07:00
Vishnu Ks 9effe27eab requirements: Upgrade typing to 3.6.4. 2018-02-14 09:41:49 -08:00
Vishnu Ks 416338c9b6 requirements: Upgrade Sphinx to 1.7.0. 2018-02-14 09:41:49 -08:00
Vishnu Ks d8eb4a115c requirements: Upgrade Babel to 2.5.3. 2018-02-14 09:41:49 -08:00
Tim Abbott 6981ac3d2f requirements: Add back explicit typing dependencies.
These are needed to make the output the same on Trusty and Xenial.
2017-11-20 13:47:16 -08:00
Harshit Bansal e75f0c1ee4 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-21 02:38:26 +05:30