David Smith
951dcbb2e6
[4.2.x] Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+.
...
Backport of b3e0170ab5
from main
2023-08-03 09:32:03 +02: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
f0480ddd2d
Fixed crash building HTML docs since Sphinx 4.3.
...
See dd2ff3e911
.
2021-11-17 12:31:25 +01:00
David Smith
f9b7704ab3
Refs #32956 -- Corrected spelling of "gray".
2021-08-02 07:51:24 +02:00
Mariusz Felisiak
36a2e9607e
Made default_role_error use logger.
...
This prevents raising errors for translated docs, see
https://github.com/django/djangoproject.com/issues/997
Follow up to 1cdfe8d912
.
2020-06-03 11:42:42 +02:00
Nick Pope
8f10ceaa90
Changed '%s' % value
pattern to str(value)
.
2020-05-04 08:27:18 +02:00
Tim Graham
ee37d2070a
Sorted imports in docs/_ext/djangodocs.py.
2020-04-14 07:31:36 +02:00
Mariusz Felisiak
a4e4737cf3
Fixed CodeBlock deprecation warning on Sphinx 2.1+.
2020-04-07 09:48:52 +02:00
Adam Johnson
1cdfe8d912
Prevented (and corrected) single backtick usage in docs.
2020-04-01 14:55:11 +02:00
Baptiste Mispelon
89d41cba39
Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+.
2019-11-25 10:33:33 +01:00
Sergey Fedoseev
5032556483
Made versionadded/versionchanged annotations without a content end with ".".
...
Regression in d2afa5eb23
.
2019-11-21 09:03:18 +01:00
Tim Graham
7206601040
Fixed crash building translated docs since Sphinx 1.8.
2018-10-01 20:44:02 -04:00
Thomas Grainger
c99d379f53
Updated contributing tutorial's virtual environment instructions.
2018-09-19 14:37:44 -04:00
Tim Graham
a0ef6a0e22
Fixed env.note_versionchange() deprecation warning in Sphinx 1.8.
2018-09-11 09:22:35 -04:00
Tim Graham
cc4bb110d3
Removed usage of deprecated sphinx APIs.
2018-09-10 16:08:21 -04:00
Curtis Maloney
c49ea6f591
Refs #20910 -- Replaced snippet directive with code-block.
2018-09-10 13:00:34 -04:00
Tim Graham
de0e54ea00
Bumped minimum Sphinx version to 1.6.0.
2018-03-22 20:30:03 -04:00
Roy Zwambag
fe32fe1619
Used console directive in "Writing documentation".
2018-03-07 16:19:22 -05:00
Ramiro Morales
37c17846ad
Fixed #28343 -- Add an OS chooser for docs command line examples.
2018-01-20 12:38:48 -05:00
Дилян Палаузов
d2afa5eb23
Fixed #28860 -- Removed unnecessary len() calls.
2017-12-04 10:35:23 -05:00
Jon Dufresne
2c69824e5a
Refs #23968 -- Removed unnecessary lists, generators, and tuple calls.
2017-06-01 19:08:59 -04:00
Tim Graham
cb16458c4f
Removed usage of deprecated sphinx.util.compat.Directive.
2017-05-24 10:39:51 -04:00
Dmitry Shachnev
f370bfb108
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
chillaranand
dc165ec8e5
Refs #23919 -- Replaced super(ClassName, self) with super() in docs.
2017-01-25 11:53:05 -05:00
Tim Graham
e5d3f98abc
Fixed missing versionadded/changed annotations on docs.djangoproject.com.
...
Fixed a regression in bacdfbf3d1
.
2016-12-14 14:31:29 -05:00
Tim Graham
bacdfbf3d1
Removed deprecated html_translator_class sphinx config option.
2016-12-05 14:47:44 -05:00
Ramin Farajpour Cami
0a63ef3f61
Fixed #27463 -- Fixed E741 flake8 warnings.
2016-11-14 17:40:28 -05:00
Baptiste Mispelon
a86fdfaa3b
Added copy-to-clipboard support for all code snippets
2016-07-06 17:11:59 +02:00
Tim Graham
e519aab43a
Fixed #23868 -- Added support for non-unique django-admin-options in docs.
...
Also documented missing short command line options to fix #24134 . This bumps
the minimum sphinx version required to build the docs to 1.3.4.
Thanks Simon Charette for review.
2016-01-14 18:21:33 -05:00
Tim Graham
03306a187e
Declared Sphinx extensions safe for parallel reading.
2016-01-13 11:33:25 -05:00
Tim Graham
c315f96024
Removed a docs workaround for an old Sphinx version.
2015-11-16 18:49:32 -05:00
Tim Graham
e48a5b5a03
Fixed #23751 -- Fixed code snippet formatting in docs PDF.
...
Thanks Graham Wideman for the patch.
2015-11-16 18:49:31 -05:00
Tim Graham
0ed7d15563
Sorted imports with isort; refs #23860 .
2015-02-06 08:16:28 -05:00
Christoph Heer
d47409831f
Fixed #23067 -- Updated docs to use django-admin
2014-07-30 14:14:03 -04:00
Tim Graham
7f4347b176
Removed duplicate "Deprecated in Django A.B" text in docs.
...
sphinx 1.2+ adds this text itself.
2014-06-06 20:31:23 -04:00
Tim Graham
e1d18b9d2e
Fixed #21869 -- Fixed docs building with Sphinx 1.2.1.
...
Thanks tragiclifestories for the report.
2014-01-24 08:52:43 -05:00
Loic Bistuer
6685713869
Fixed E127 pep8 warnings.
2013-12-14 11:59:15 -05:00
Tim Graham
b63acdfe71
Removed a u'' prefix that prevented the docs from building on Python 3.2.
2013-12-06 13:06:59 -05:00
Alex Gaynor
ac17525039
Replace use of dict.has_key with key in dict
2013-11-26 14:32:14 -06:00
Alex Gaynor
fe995e6cbd
Fixed the remaining E302 violations int eh django package
2013-11-02 17:37:15 -07:00
Boryslav Larin
e737c009b8
Fixed flake8 E241
2013-11-02 21:45:40 +02:00
Tim Graham
1597503a01
Fixed E221 pep8 warnings.
2013-10-22 09:51:39 -04:00
M Nasimul Haque
d07d6ae116
Fixed #20910 -- Added a "snippet" sphinx directive to allow prefixing a filename.
...
Thanks Marc Tamlyn for the suggestion.
2013-10-14 13:00:57 -04:00
Tim Graham
a3a59a3197
Added a bugfix in docutils 0.11 -- docs will now build properly.
2013-07-31 09:24:29 -04:00
Ramiro Morales
0fa8d43e74
Replaced and...or...
constructs with PEP 308 conditional expressions.
2013-05-26 23:47:50 -03:00
Juan Catalano
78c842a323
Adapted uses of versionchanged/versionadded to the new form.
...
Refs #20104 .
2013-04-20 17:18:35 +02:00
Juan Catalano
1ddeeb5b8e
Removed unused imports.
2013-04-20 17:18:29 +02:00
Juan Catalano
4e25198ec2
Fixed #20104 -- Changed VersionDirective in order to avoid ambiguity.
...
As explained in ticket #20104 , the use of versionchanged/versionadded
was confusing.
To solve this ambiguity these directives no longer accept a second
argument but now they only receive the version number (1st arg) and then
a content with the proper comment.
2013-04-20 17:18:21 +02:00
Gavin Wahl
ec04fd1344
Fixed spelling errors
2013-03-28 11:16:53 -06:00