de0e54ea00
Bumped minimum Sphinx version to 1.6.0.
2018-03-22 20:30:03 -04:00
fe32fe1619
Used console directive in "Writing documentation".
2018-03-07 16:19:22 -05:00
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
2c69824e5a
Refs #23968 -- Removed unnecessary lists, generators, and tuple calls.
2017-06-01 19:08:59 -04:00
cb16458c4f
Removed usage of deprecated sphinx.util.compat.Directive.
2017-05-24 10:39:51 -04:00
f370bfb108
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
dc165ec8e5
Refs #23919 -- Replaced super(ClassName, self) with super() in docs.
2017-01-25 11:53:05 -05:00
e5d3f98abc
Fixed missing versionadded/changed annotations on docs.djangoproject.com.
...
Fixed a regression in bacdfbf3d1
2016-12-14 14:31:29 -05:00
bacdfbf3d1
Removed deprecated html_translator_class sphinx config option.
2016-12-05 14:47:44 -05:00
0a63ef3f61
Fixed #27463 -- Fixed E741 flake8 warnings.
2016-11-14 17:40:28 -05:00
a86fdfaa3b
Added copy-to-clipboard support for all code snippets
2016-07-06 17:11:59 +02:00
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
03306a187e
Declared Sphinx extensions safe for parallel reading.
2016-01-13 11:33:25 -05:00
c315f96024
Removed a docs workaround for an old Sphinx version.
2015-11-16 18:49:32 -05:00
e48a5b5a03
Fixed #23751 -- Fixed code snippet formatting in docs PDF.
...
Thanks Graham Wideman for the patch.
2015-11-16 18:49:31 -05:00
0ed7d15563
Sorted imports with isort; refs #23860 .
2015-02-06 08:16:28 -05:00
d47409831f
Fixed #23067 -- Updated docs to use django-admin
2014-07-30 14:14:03 -04:00
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
e1d18b9d2e
Fixed #21869 -- Fixed docs building with Sphinx 1.2.1.
...
Thanks tragiclifestories for the report.
2014-01-24 08:52:43 -05:00
6685713869
Fixed E127 pep8 warnings.
2013-12-14 11:59:15 -05:00
b63acdfe71
Removed a u'' prefix that prevented the docs from building on Python 3.2.
2013-12-06 13:06:59 -05:00
ac17525039
Replace use of dict.has_key with `key in dict`
2013-11-26 14:32:14 -06:00
fe995e6cbd
Fixed the remaining E302 violations int eh django package
2013-11-02 17:37:15 -07:00
e737c009b8
Fixed flake8 E241
2013-11-02 21:45:40 +02:00
1597503a01
Fixed E221 pep8 warnings.
2013-10-22 09:51:39 -04:00
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
a3a59a3197
Added a bugfix in docutils 0.11 -- docs will now build properly.
2013-07-31 09:24:29 -04:00
0fa8d43e74
Replaced `and...or...` constructs with PEP 308 conditional expressions.
2013-05-26 23:47:50 -03:00
78c842a323
Adapted uses of versionchanged/versionadded to the new form.
...
Refs #20104 .
2013-04-20 17:18:35 +02:00
1ddeeb5b8e
Removed unused imports.
2013-04-20 17:18:29 +02:00
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
ec04fd1344
Fixed spelling errors
2013-03-28 11:16:53 -06:00
a5733fcd7b
Fixed creation of html docs on python 3.
...
Thanks to Alan Lu for the report and the patch.
2013-02-24 15:45:53 +01:00
d93edffa89
Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives
...
Also bumped django_next_version back to 1.6 so those
annotations are described as "the development version"
in the docs.
Thanks Aymeric for the patch.
2013-02-09 09:16:10 -05:00
865cd35c9b
Made more extensive usage of context managers with open.
2012-05-05 14:06:36 +02:00
cec6bd5a59
Fixed #18023 -- Removed bundled simplejson.
...
And started the deprecation path for django.utils.simplejson.
Thanks Alex Ogier, Clueless, and other contributors for their
work on the patch.
2012-04-29 19:58:00 +02:00
e1ba9111ac
Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed
...
Thanks to datakid for the report
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17367 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-01-11 10:19:05 +00:00
c61987d75a
Removed use of non-standard indentation rules in docs, and the custom transform that supported them.
...
Doc writers should be aware that we are now back to normal ReST rules
regarding blockquotes.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16955 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-10-10 17:32:33 +00:00
b95c06d423
Made fix for quote characters with SmartPants + parsed literal blocks conditional on Sphinx version.
...
This hs been fixed upstream in releases >= 1.0.8 (issue 647.)
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16952 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-10-10 00:23:47 +00:00
66fd824ee0
Fixed djangodocs Sphinx extension to work with latest Sphinx
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16231 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-05-15 23:02:36 +00:00
e127e17b49
Fixed our Sphinx extension to work with latest Sphinx
...
This is pretty hacky, but there doesn't seem to be a nice way to fix it,
since we can't call the base method - we are deliberately overriding it in
order to not call the base method, which adds an unwanted 'border=1' to the
HTML.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16223 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-05-14 02:58:58 +00:00
d4bb8313f7
Reformated some code for readability.
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14652 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-20 21:00:41 +00:00
ec7c49f253
Fixed hyperlinking of template tags for Sphinx >= 1.0
...
Follow on from incomplete fix in [14477], and [14631] which removed
compatibility for Sphinx < 1.0
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14639 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-20 01:37:54 +00:00
f609306349
Removed compatibility with Sphinx < 1.0 workarounds in our extension code. Also, started to use the 'needs_sphinx' Sphinx config var.
...
Follow up on r14624.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14631 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-19 23:19:56 +00:00
57f49453c7
Fixed hyperlinking of template tags/filters in offline docs so that non-builtin tags/filters are not hyperlinked to a page where no docs for them exist
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14477 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-06 17:42:21 +00:00
4239bb0f35
Documented options accepted by the runfcgi management command.
...
Also, modified our custom management command option docs xref parser
to also process those without a ``--`` prefix. -- Refs #14398 .
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14361 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-10-27 15:35:07 +00:00
728effcfbd
Fixed #14141 : docs now use the :doc: construct for links between documents.
...
Thanks, Ramiro Morales.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-19 19:27:44 +00:00
7098f8444e
Fixed #14033 -- Fixed another problem with xrefs and Sphinx 1.X in the Django doc extension. Thanks for the report and patch, Ramiro Morales and Georg Brandl.
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13602 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-18 16:31:15 +00:00
cd8758ef4d
Fixed #14005 - Removed a few unneeded workarounds in the Sphinx extension. Thanks for the report and patch, Ramiro Morales.
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13447 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-07-25 20:39:40 +00:00
Tim Graham
Roy Zwambag
Ramiro Morales
Дилян Палаузов
Jon Dufresne
Dmitry Shachnev
chillaranand
Ramin Farajpour Cami
Baptiste Mispelon
Christoph Heer
Loic Bistuer
Alex Gaynor
Boryslav Larin
M Nasimul Haque
Ramiro Morales
Juan Catalano
Gavin Wahl
Florian Apolloner
Claude Paroz
Aymeric Augustin
Luke Plant
Jacob Kaplan-Moss
Jannis Leidel