Commit Graph

132 Commits

Author SHA1 Message Date
Natalia 47b921391f Removed unnecessary trailing slashes in Sphinx intersphinx_mapping URLs. 2024-08-23 11:15:16 -03:00
David Smith 0304f677ca Updated Sphinx source_suffix setting to use a mapping.
Since Sphinx 1.8 this setting should be a mapping of file extensions to
file types. Before this change, Sphinx 8+ would show the following  when
building docs:

Converting `source_suffix = '.txt'` to `source_suffix = {'.txt': 'restructuredtext'}`
2024-08-23 11:15:16 -03:00
Natalia b625764744 Bumped version; main is now 5.2 pre-alpha. 2024-05-22 15:44:07 -03:00
Joachim Jablon b691accea1 Fixed #29942 -- Restored source file linking in docs by using the Sphinx linkcode ext.
Co-authored-by: David Smith <smithdc@gmail.com>
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2024-05-14 22:08:29 -03:00
Mariusz Felisiak b9a25b69ae Bumped version; main is now 5.1 pre-alpha. 2023-09-18 22:12:40 +02:00
Mariusz Felisiak 9b9c805ced
Removed unneeded escapes in regexes.
Special characters lose their special meaning inside sets of characters.

"-" lose its special meaning if it's placed as the first or last
character.

Follow up to 7c6b66383d.
2023-08-02 19:53:16 +02:00
Tim Graham 2c4dc64760 Used extlinks for PyPI links.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-04-17 06:55:32 +02:00
Liyang Zhang f9f9215d3e
Fixed some typos in comments, docstrings, and tests. 2023-03-20 08:07:23 +01:00
Mariusz Felisiak d18d6d0d78 Bumped version; master is now 5.0 pre-alpha. 2023-01-17 11:49:15 +01:00
Mariusz Felisiak 279967ec85
Disabled auto-created table of contents entries on Sphinx 5.2+.
Auto-created table of contents entries for all domain objects (e.g.
functions, classes, attributes, etc.) were added in Sphinx 5.2, see
https://github.com/sphinx-doc/sphinx/issues/6316.

An option to control new table of contents entries was added in Sphinx
5.2.3, see https://github.com/sphinx-doc/sphinx/pull/10886.
2022-12-29 06:07:51 +01:00
Daniele Varrazzo 09ffc5c121 Fixed #33308 -- Added support for psycopg version 3.
Thanks Simon Charette, Tim Graham, and Adam Johnson for reviews.

Co-authored-by: Florian Apolloner <florian@apolloner.eu>
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2022-12-15 06:17:57 +01:00
Mariusz Felisiak ebf25555bb
Bumped minimum Sphinx version to 4.5.0.
Related Sphinx changes:
- https://github.com/sphinx-doc/sphinx/pull/8898
- https://github.com/sphinx-doc/sphinx/issues/8326
2022-05-31 15:21:17 +02:00
Carlton Gibson ff8e5eacda Bumped version; main is now 4.2 pre-alpha. 2022-05-17 14:22:06 +02:00
Nick Pope 62ffc9883a
Updated bpo link to use redirect URI.
Mirrors the change made in python/cpython#32342.
2022-04-13 13:27:41 +02:00
Adam Johnson a45f28f0ec Rewrote strip_tags test file to lorem ipsum. 2022-03-08 14:50:06 +01:00
Adam Johnson a8c15481f4 Rewrote some references to "master".
Following d9a266d657.
2022-03-08 14:50:06 +01:00
Mariusz Felisiak 7119f40c98 Refs #33476 -- Refactored code to strictly match 88 characters line length. 2022-02-07 20:37:05 +01:00
django-bot 9c19aff7c7 Refs #33476 -- Reformatted code with Black. 2022-02-07 20:37:05 +01:00
Mariusz Felisiak adb4100e58
Refs #33247 -- Used XeLaTeX for PDF docs build. 2021-11-12 09:36:18 +01:00
Andrew Neitsch 95a4db3fbd Refs #33247 -- Fixed rendering of Unicode chars and emojis in PDF docs build. 2021-11-04 08:06:03 +01:00
Mariusz Felisiak a7dc745ee5 Bumped version; main is now 4.1 pre-alpha. 2021-09-20 21:23:01 +02:00
David Smith 1024b5e74a Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
Mariusz Felisiak 37e8367c35
Refs #31676 -- Removed Django Core-Mentorship mailing list references in docs. 2021-07-13 20:21:22 +02:00
Mariusz Felisiak f10c52afab
Refs #31356 -- Changed IRC links to the Libera.Chat webchat.
Follow up to 66491f08fe.
2021-06-03 12:07:30 +02:00
Mariusz Felisiak 66491f08fe
Changed IRC references to Libera.Chat. 2021-05-20 12:23:36 +02:00
Nick Pope 0851933cba Fixed #32720 -- Added configuration and docs for Sphinx link checker.
We explicitly ignore checking anchors for line-range anchors on GitHub
which are dynamically generated and, otherwise, show up as broken links.

See https://github.com/sphinx-doc/sphinx/issues/7388#issuecomment-739961689.

We also ignore links to resources that require authentication.
2021-05-17 11:21:35 +02:00
Nick Pope c156e36955 Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS. 2021-05-17 09:46:09 +02:00
Markus Holtermann d9a266d657 Updated Git branch "master" to "main".
This change follows a long discussion on django-develops:

https://groups.google.com/g/django-developers/c/tctDuKUGosc/
2021-03-09 08:48:32 +01:00
Mariusz Felisiak 9f125fce79 Used GitHub actions for docs tests.
Co-Authored-By: Tom Forbes <tom@tomforb.es>
2021-02-26 22:12:25 +01:00
Nick Pope d02d60eb0f Added documentation extlink for bugs.python.org. 2021-02-17 14:24:42 +01:00
Mariusz Felisiak f20a622aea Bumped version; master is now 4.0 pre-alpha. 2021-01-14 17:50:04 +01:00
Tim Graham 656b331b13
Updated CVE URL. 2021-01-02 12:49:00 +01:00
Mariusz Felisiak 6b9b2af735 Bumped version; master is now 3.2 pre-alpha. 2020-05-13 09:07:51 +02:00
Adam Johnson 1cdfe8d912 Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
Abhijeet 1a9459b88e
Fixed #28290 -- Enabled Sphinx auto-label generation for title and section headers. 2020-01-29 14:34:14 +01:00
Jon Dufresne 958977f662 Fixed #31212 -- Updated psycopg links to HTTPS and new location. 2020-01-29 06:25:40 +01:00
Jon Dufresne 32166a9f7c
Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
Mariusz Felisiak 0f2f517298 Bumped version; master is now 3.1 pre-alpha. 2019-09-10 11:54:25 +02:00
Tim Graham 879cc3da62 Moved extlinks in docs config to allow using 'version' variable.
After a stable branch is created, 'master' will change to
'stable/' + version + '.x'.
2019-03-28 20:47:51 -04:00
Tim Graham a68c029e22
Used extlinks for Django's source code. 2019-03-28 20:32:17 -04:00
Tim Graham c34c6d0a2f Used extlinks for GitHub commits. 2019-02-01 21:42:48 +01:00
Tim Graham ffe53096a9 Bumped version; master is now 3.0 pre-alpha. 2019-01-17 10:50:24 -05:00
Tim Graham 7ed4713a90 Removed obsolete html_use_smartypants Sphinx option. 2018-09-18 11:51:04 -04:00
Tim Graham 44f98f7880 Replaced CVE/ticket roles with extlinks. 2018-08-27 10:29:13 -04:00
Tim Graham 9f6188bff3 Bumped version to 2.2 in docs. 2018-05-17 20:48:45 -04:00
Tim Graham cf8fc47974 Updated intersphinx_mapping URL for sphinx. 2018-04-04 11:32:14 -04:00
Tim Graham de0e54ea00 Bumped minimum Sphinx version to 1.6.0. 2018-03-22 20:30:03 -04:00
Ramiro Morales 37c17846ad Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
Mariusz Felisiak 83a36ac49a
Removed unnecessary trailing commas and spaces in various code. 2017-12-28 21:07:29 +01:00
Ramiro Morales e67733aa65 Fixed #28963 -- Raised minimum Sphinx version. 2017-12-25 14:17:09 -03:00