Commit Graph

29 Commits

Author SHA1 Message Date
Tim Graham f2969c7e02 [1.5.x] Added a bugfix in docutils 0.11 -- docs will now build properly.
Backport of a3a59a3197 from master
2013-07-31 09:26:23 -04:00
Gavin Wahl d1b7bd030b [1.5.x] Fixed spelling errors
Backport of ec04fd1344 from master
2013-03-29 08:00:24 -04:00
Tim Graham 7b278278ab [1.5.x] Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives
Thanks Aymeric for the patch.

Backport of d93edffa89 from master.
2013-02-09 09:22:33 -05:00
Claude Paroz 865cd35c9b Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
Claude Paroz 596cb9c7e2 Replaced print statement by print function (forward compatibility syntax). 2012-04-30 20:45:03 +02:00
Aymeric Augustin 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
Luke Plant 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
Luke Plant 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
Ramiro Morales 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
Luke Plant 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
Luke Plant 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
Alex Gaynor 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
Luke Plant 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
Ramiro Morales 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
Luke Plant 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
Ramiro Morales 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
Jacob Kaplan-Moss 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
Jannis Leidel 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
Jannis Leidel 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
Jannis Leidel fad4a93275 Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13446 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-07-24 10:21:21 +00:00
Luke Plant b09581394e Added hyperlinks for builtin template tags and filters to code samples in docs.
Implemented in javascript because doing it 'properly' is pretty much impossible with Sphinx and Pygments.

Refs #12249



git-svn-id: http://code.djangoproject.com/svn/django/trunk@13135 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-05-08 14:31:20 +00:00
Justin Bronn d58020fce8 Fixed `fieldlookup` docs cross-reference directive, and added it to the queryset reference. Refs #12930.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@12808 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-03-20 05:04:31 +00:00
Russell Keith-Magee f5ed3f4085 Fixed #10539 -- Updated Sphinx configuration to accommodate 0.6 while retaining compatibility with 0.4 and 0.5. Thanks to Ramiro Morales for the patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@11162 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-07-03 05:40:46 +00:00
Malcolm Tredinnick 059765fa6c Fixed #9436 -- Updated docs build code to create "new in development version".
Patch from Marc Fargas.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10006 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-09 01:37:17 +00:00
Malcolm Tredinnick e8707e068d Fixed #9645 -- Work around a backwards-incompatibility in Sphinx so that
various combinations of released docutils and sphinx versions all work
together. Thanks, Ramiro Morales.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@9586 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-12-07 04:00:08 +00:00
Jacob Kaplan-Moss ecb5f4c693 Fixed the documentation HTML writer to not apply smartypants to literal blocks. Fixes #8696; thanks, ramiro.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8875 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-02 19:49:23 +00:00
Jacob Kaplan-Moss 64a9469127 Fixed #8753: converted "new in ..." callouts to proper Sphinx "versionadded/versionchanged" directives. Thanks to Marc Fargas for all the heavy lifting here.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8843 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-02 03:40:42 +00:00
Jacob Kaplan-Moss e3fad41859 A noble spirit no longer embiggens the smallest function signatures.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8593 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-26 19:38:27 +00:00
Jacob Kaplan-Moss 97cb07c3a1 Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8506 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-23 22:25:40 +00:00