Commit Graph

124 Commits

Author SHA1 Message Date
Tim Graham a46742e738 Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04:00
Tim Graham af32737573 Ignored new warnings when building the docs with Sphinx 1.4. 2016-06-01 11:03:41 -04:00
Tim Graham 8df083a3ce Bumped version; master is now 1.11 pre-alpha. 2016-05-19 22:20:21 -04:00
Tim Graham f945fb24a3 Fixed #26554 -- Updated docs URLs to readthedocs.io 2016-04-28 10:09:57 -04:00
Tim Graham 6a71ac61bd Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs. 2016-02-16 07:30:32 -05: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 d45cfefbad Refs #25769 -- Updated docs to reflect get_version() uses PEP 0440. 2016-01-13 07:06:34 -05:00
Josh Soref 93452a70e8 Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
Jon Dufresne 7aabd62380 Fixed #25778 -- Updated docs links to use https when available. 2015-12-01 08:01:34 -05:00
Tim Graham c315f96024 Removed a docs workaround for an old Sphinx version. 2015-11-16 18:49:32 -05:00
Tim Graham a80d70dd10 Refs #23751 -- Added some unicode characters to the latex preamble.
Thanks Graham Wideman for the patch.
2015-11-16 18:49:32 -05:00
Tim Graham a1058e8d7c Bumped version; master is now 1.10 pre-alpha. 2015-09-23 19:31:08 -04:00
Dražen Odobašić b1e33ceced Fixed #23395 -- Limited line lengths to 119 characters. 2015-09-12 11:40:50 -04:00
Erik Romijn f66c2bdc0f Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
Collin Anderson db77915c9f Fixed E265 comment style 2015-02-06 09:30:35 -05:00
Tim Graham d4689034be Bumped version to 1.9 in docs config. 2015-01-16 18:30:28 -05:00
Marc Tamlyn 48ad288679 Fixed #24001 -- Added range fields for PostgreSQL.
Added support for PostgreSQL range types to contrib.postgres.

- 5 new model fields
- 4 new form fields
- New validators
- Uses psycopg2's range type implementation in python
2015-01-10 16:18:19 +00:00
Claude Paroz 0a4b04fc23 Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
Jannis Leidel 6302893112 Updated formtools docs to point at new package outside the Django repo.
Refs #23677.
2014-11-26 09:41:52 -05:00
Berker Peksag 695956376f Removed simplejson inventory file from docs/conf.py. 2014-10-25 07:31:12 +03:00
Tim Graham fca677fa43 Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
Tim Graham 9ed4a8c6b1 Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode.
Thanks santiagobasulto for the suggestion.
2014-06-07 08:54:54 -04:00
Alex Gaynor 1dcc603eff Fixed several typos in Django 2014-05-28 17:39:14 -07:00
Claude Paroz 680a0f08b1 Updated doc links to point to Python 3 documentation 2014-04-26 16:02:53 +02:00
Tim Graham 2f37ad88b1 Bumped version to reflect master is now pre-1.8. 2014-03-21 06:17:14 -04:00
Szczepan Cieślik a0f2525202 Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
Markus Amalthea Magnuson 59d9b26474 Fixed #21190 -- Added a new ePub theme for documentation. 2014-02-10 08:24:40 -05:00
Aymeric Augustin e5c89c62f2 Pointed intersphinx links to Python's default version.
Currently it's 3.3.
2013-12-30 19:09:45 +01:00
coagulant 3bc0d46a84 Fixed all E261 warnings 2013-11-02 18:20:39 -04:00
Tim Graham ae48d77ef8 Fixed E225 pep8 warnings. 2013-10-23 06:09:29 -04:00
Alasdair Nicol dfb4cb9970 Fixed #21285 -- Fixed E121,E122 pep8 warnings 2013-10-17 20:20:11 -04:00
Unai Zalakain 3895d8899d Fixed #21213 -- Added docs for Django's mailing lists.
Added docs/internals/mailing-lists.txt documenting the use of django's
mailing lists. All references across docs changed to point to this page.

The referencing makes use of substitution because there's no way to make
a :ref: link in a non-inline fashion in Sphinx. It also makes use of
rst_epilog Sphinx conf for making this substitutions across all the
docs.
2013-10-04 10:00:36 -04:00
Rogério Yokomizo 1b4b710355 Fixed #21141 -- Update Sphinx URL
Updated Sphinx URL from http://sphinx.pocoo.org/ to http://sphinx-doc.org/.
2013-09-22 14:44:09 -03:00
Jacob Kaplan-Moss 27cf7ec864 Master is now pre-1.7. 2013-06-28 08:56:45 -05:00
Claude Paroz 6a092f24e0 Allow build of translated documentation 2013-06-08 16:13:51 +02:00
Aymeric Augustin 749c2e4333 Fixed URL for six inventory. 2013-05-27 11:15:40 +02:00
Tim Graham 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
Tim Graham b3a8c9dab8 Fixed broken links, round 3. refs #19516 2012-12-26 19:07:22 -05:00
Ramiro Morales 514ce1d35f Fixed two docstring/comment typos. 2012-11-28 20:28:30 -03:00
Ramiro Morales f3a0ecc9ee Changed (again) technique to get version IDs shown in docs from source code.
Hopefully it will fix the problem with the documentation building server
that caused a wrong Django version to be reported in the HTML zipball
docs edition.

Follow-up to commits 373df56 and 0b98ef6.
2012-11-25 11:58:06 -03:00
Claude Paroz a79d920a56 Fixed #19266 -- Added Texinfo documentation target
Thanks orontee for the report and initial patch.
2012-11-09 09:00:27 +01:00
Ramiro Morales 0b98ef6321 Ensure that version detection in docs from 373df56d uses the right Django copy. 2012-10-28 18:18:09 -03:00
Ramiro Morales 373df56d36 Advanced version identifiers for 1.6 cycle. 2012-10-26 22:01:34 -03:00
Florian Apolloner e98eff836d Added latex preamble for ≤.
Thanks to bnomis for the report and yajogo for the initial patch.
2012-08-28 22:45:51 +02:00
Florian Apolloner 4d9e4c64f1 Fixed #18698 -- Configure latex to support '≥' in the docs.
Thanks to simonb for the report and the initial patch.
2012-08-11 21:48:11 +02:00
Aymeric Augustin 00ace01411 [py3] Documented coding guidelines for Python 3. 2012-07-22 10:29:07 +02:00
Claude Paroz 4a103086d5 Fixed #18269 -- Applied unicode_literals for Python 3 compatibility.
Thanks Vinay Sajip for the support of his django3 branch and
Jannis Leidel for the review.
2012-06-07 18:08:47 +02:00
Aymeric Augustin b49bc5c990 Removed a svn-specific configuration for Sphinx. 2012-04-28 15:03:16 +02:00
Ramiro Morales f38cf60c35 Advanced version identifiers for 1.5 development cycle.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17860 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-31 19:39:28 +00:00
James Bennett 2591fb8d4c Bump trunk to 1.4.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17799 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-23 16:53:23 +00:00
James Bennett e6ae858811 Bump trunk to 1.4 RC 2.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17740 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-15 03:29:49 +00:00
James Bennett 878ec9e646 Bump for 1.4 RC 1.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17671 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-05 17:22:23 +00:00
James Bennett 46671e9b68 Bump version numbers for 1.4 beta 1.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17531 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-02-16 02:12:20 +00:00
James Bennett 0e29e48c05 Bump to 1.4 alpha 1.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17255 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-23 04:00:26 +00:00
Ramiro Morales 932b1b8d6d Converted links to external topics so they use intersphinx extension markup.
This allows to make these links more resilent to changes in the target URLs.
Thanks Jannis for the report and Aymeric Augustin for the patch.

Fixes #16586.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16720 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-09-04 21:17:30 +00:00
Simon Meers 1339ef4af8 Bumped django_next_version so that "New in Django 1.3" links appear correctly.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15909 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-03-24 09:40:50 +00:00
James Bennett 7c08f4c635 Bump everything for 1.3.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15902 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-03-23 05:06:31 +00:00
Jannis Leidel 2d29c11117 Fixed #15196 -- Bumped version up a bit in Sphinx configuration. Thanks, Eric Holscher.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15374 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-01-30 20:31:39 +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
Alex Gaynor 0aeb6c964a Added a hidden toctree pointing at the index file in the docs to silence a sphinx warning.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14605 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-17 20:26:20 +00:00
Jannis Leidel 480c6c6958 Disabled unused Sphinx configuration option that triggered a warning.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14014 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-10-08 15:33:27 +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
Jacob Kaplan-Moss ffcffcb96b Updated the docs conf.py to have the correct version number.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13287 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-05-17 18:51:50 +00:00
Malcolm Tredinnick 34b4d1ef43 Bumped the version number in the docs to reflect Djagno 1.1 is released.
This changes a bunch of "new in development version" annotations to say
"new in Django 1.1" for example.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@11413 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-08-08 02:56:19 +00:00
Jacob Kaplan-Moss 516051bfd2 A whole lotta documentation fixes: Fixes #8704, #8826, #8980, #9243, #9343, #9529,
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10303 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-31 23:34:03 +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
Russell Keith-Magee 7976817a59 Fixed #8955: Modified the sphinx configuration to generate LaTeX documentation. Thanks to simonb for the report and fix.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9068 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-18 15:46:20 +00:00
James Bennett a72eae0be7 Fixed #8728: Corrected some broken links in the documentation
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8792 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-01 09:45:30 +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
Jacob Kaplan-Moss 4c3fcbc4bc [docs] OK, I give up.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@7374 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-03-27 15:14:57 +00:00
Jacob Kaplan-Moss 905b246dad [docs] And even more svn:keywords fooling. Sorry about the timeline spam.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@7373 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-03-27 15:13:05 +00:00
Jacob Kaplan-Moss 95665c403b [docs] Added svn:keywords to docs/index.txt
git-svn-id: http://code.djangoproject.com/svn/django/trunk@7371 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-03-27 15:05:40 +00:00
Jacob Kaplan-Moss 7dd4be581b Added the basics needed to build Django's docs using [http://sphinx.pocoo.org/ Sphinx]. If you've got Sphinx installed (the latest version) along with [http://docutils.sf.net docutils], you should be able to easily build the docs locally using {{{sphinx-build}}} or the included {{{Makefile}}}. This use a basic (and pretty crappy) index for the documentation and the built-in Sphinx styles (which are actually quite nice).
git-svn-id: http://code.djangoproject.com/svn/django/trunk@7370 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-03-27 15:03:52 +00:00