Commit graph

14 commits

Author SHA1 Message Date
Pedro J. Estébanez
373e545f55 Let make_rst.py be forward compatible with 4.0's 2023-01-19 13:34:21 +01:00
Hugo Locurcio
ed380cc0fa
Add a [kbd] tag for highlighting keyboard shortcuts in the editor help
This allows backporting documentation from the `master` branch more easily,
as it already features the `[kbd]` tag.

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2022-08-25 19:53:49 +02:00
Rémi Verschelde
76440fe1aa doc: Fix relative paths in make_rst.py generated comment
Follow-up to #63495.

(cherry picked from commit f66527ddc3)
2022-07-27 15:29:28 +02:00
Yuri Sizov
ff7554413b Improve the autogenerated note in RST docs for class reference
(cherry picked from commit f3561696da)
2022-07-27 15:29:27 +02:00
Andy Maloney
7c06b9b670 Add missing Python type hints in tools/make_rst.py
(cherry picked from commit 4b3d6f04a8)
2022-07-27 15:24:15 +02:00
SnailRhymer
c8b85c1b54 Indent bullet points in enum descriptions
When converting doc xml files to rst, add an indenation level to bullet points in the text description of enum values.
Also add check to avoid out of bounds error in rstize_text.

(cherry picked from commit 38cf07b768)
2022-05-16 17:14:43 +02:00
Rémi Verschelde
7a16bb2ee4
Fix typos with codespell
Using codespell 2.2-dev from current git.

Added `misc/scripts/codespell.sh` to make it easier to run it once in a
while and update the skip and ignore lists.

(cherry picked from commit 1bdb82c64e)
2022-02-11 09:50:59 +01:00
Max Hilbrunner
54de063890 [3.x] Fix make_rst.py on Windows 2022-01-24 10:28:22 +01:00
Rémi Verschelde
c62de9abec
i18n: Make more make_rst.py strings translatable
For now we leave out the strings which could break rst table formatting.

(cherry picked from commit fd1d0c28c2)
2022-01-07 13:30:21 +01:00
Rémi Verschelde
f2ddafd860
i18n: Add --lang option to make_rst.py to write translated headings
Add a few missing headings to the translation templates.

(cherry picked from commit b98785309f)
2021-12-21 14:40:13 +01:00
Haoyu Qiu
36642738e0 Update make_rst.py for non-latin texts 2021-12-21 16:36:53 +08:00
Yuri Sizov
1cf6d21f69 Make overridden properties link to parent definition
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-03 17:48:49 +03:00
Rémi Verschelde
0cdcf1154f
Allow dehardcoding documentation branch and URL in docs links
This makes it possible to change the branch of the documentation that
URLs are pointing to without having to modify all class reference
files.

In the XML class reference, the `$DOCS_URL` placeholder should be used,
and will be replaced automatically in the editor and when generating
the RST class reference.

The documentation branch string is set in `version.py`.

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit 5341e6010e)
2021-11-15 17:22:47 +01:00
Aaron Franke
69e90daae3
Rename "makerst.py" to "make_rst.py"
(cherry picked from commits 8f05e26198
and cce7797a75)
2021-10-26 13:34:36 +02:00
Renamed from doc/tools/makerst.py (Browse further)