Commit Graph

42 Commits

Author SHA1 Message Date
Hasan Ramezani 33f7739108 Fixed #31356 -- Changed IRC links to the Freenode webchat. 2020-04-29 20:08:36 +02:00
Mariusz Felisiak cc70a0343e
Fixed term warning on Sphinx 3.0.1+.
"term" role became case sensitive in Sphinx 3.0.1.
2020-04-14 09:32:09 +02:00
Jon Dufresne 32166a9f7c
Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
Fredrik c3ee42d663 Refs #20935 -- Removed inappropriate crosslink to docs search results page.
The link to the search page does not work in the Epub, since there is no such thing. In the online docs, the link to the search page displays a “No search query given” error, since its purpose is to display results from the search bar. Alone, without a query, it's just empty.
2019-12-04 11:36:40 +01:00
Tobias Kunze 4a954cfd11 Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:

- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous

Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
2019-09-06 13:27:46 +02:00
Ramiro Morales aed89adad5 Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
Tim Graham a68c029e22
Used extlinks for Django's source code. 2019-03-28 20:32:17 -04:00
Tim Graham 4775dcb521 Renamed the "Supported versions" label. 2018-01-31 10:17:06 -05:00
Ramiro Morales 37c17846ad Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
Tim Graham afd50a3019 Replaced "trunk" with "master branch" in docs. 2018-01-18 16:30:38 -05:00
Tim Graham cd58f13fb6 Removed obsolete note about Sphinx version required for building docs. 2016-08-09 18:11:26 -04:00
shaunagm 44c7e5d374 Fixed #26701 -- Replaced /newticket links to Trac with /. 2016-06-03 08:48:12 -04:00
Jon Dufresne 7aabd62380 Fixed #25778 -- Updated docs links to use https when available. 2015-12-01 08:01:34 -05:00
Agnieszka Lasyk 1f8dad6915 Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
Sean Wang eba6dff581 Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
Corey Farwell 37b13033c6 Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
Szczepan Cieślik e816198034 Fixed docs typos. 2014-02-25 10:28:32 -05: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
Tim Graham 31ee120787 Fixed #20667 - Removed discussion of DEBUG from tutorial.
Forward-port of 3493f18d78 from master.
2013-08-01 18:07:59 -04:00
Aymeric Augustin b99a4e1073 Updated metrics on the documentation. 2013-01-29 14:12:04 +01:00
Tim Graham 5c143cb340 Fixed #19180 - Clarified policy regarding older versions of the docs. 2012-10-25 17:55:42 -04:00
Julien Phalip 6eb4f25692 Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
Claude Paroz 8a5d1a6b93 Updated obsolete links in the documentation 2012-06-28 10:49:07 +02:00
Aymeric Augustin 6a66fc08b3 Fixed #17933 -- Added a missing label to the docs. 2012-06-07 19:47:32 +02:00
Adrian Holovaty bcdc99dda2 Updated docs/intro/whatsnext.txt to reference Git instead of SVN 2012-04-27 22:57:23 -05:00
Claude Paroz 78638a9a51 Replaced http by https in djangoproject.com links
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17703 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-13 17:53:31 +00:00
Aymeric Augustin c0e73a4909 Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17636 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-03 09:11:54 +00:00
Luke Plant d1e5c55258 Fixed many more ReST indentation errors, somehow accidentally missed from [16955]
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16983 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-10-14 00:12:01 +00:00
Jannis Leidel 8f7b5024b2 Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16547 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-07-19 09:00:24 +00:00
Russell Keith-Magee a904e55859 Fixed #11509 -- Modified usage of "Web" to match our style guide in various documentation, comments and code. Thanks to timo and Simon Meers for the work on the patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14069 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-10-09 08:12:50 +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 806c30cd63 Fixed #14111 -- Updated Sphinx version recommendation in documentation. Thanks, Ramiro Morales and Paul McMillan.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13604 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-08-18 16:34:50 +00:00
Russell Keith-Magee d73eb089f2 Fixed #13333 -- Corrected typo in whatsnew docs. Thanks to cicatrix1 for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13195 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-05-10 11:35:43 +00:00
Karen Tracey 8955a085a5 Fixed #9491 -- Added a missing 'the' in what to read next. Thanks mh983.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9310 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-11-01 18:04:36 +00:00
Adrian Holovaty 834a041e67 Fixed #8982 -- Removed funky character from whatsnext.txt. Thanks, Fernando Correia
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8986 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-09 01:43:17 +00:00
Jacob Kaplan-Moss 23f012dbfa Cleaned up a bunch of minor doc stuff:
* Removed flatpages/redirects README; no other contrib apps have those.
  * Cleaned up top-level README to be more readable.
  * Removed outdated references to old docs (Fixes #8701)

git-svn-id: http://code.djangoproject.com/svn/django/trunk@8857 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-02 16:42:13 +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
James Bennett ac418c979f Fixed #8581: Corrected example of "grep" to search docs
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8736 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-30 05:35:18 +00:00
Russell Keith-Magee 369b4270fa Fixed #8581: Updated the suggested command for a low-tech documentation search. Thanks to Manuel Saelices for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8654 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-28 11:46:34 +00:00
Gary Wilson Jr c2ba59fc1d Removed oldforms, validators, and related code:
* Removed `Manipulator`, `AutomaticManipulator`, and related classes.
 * Removed oldforms specific bits from model fields:
   * Removed `validator_list` and `core` arguments from constructors.
   * Removed the methods:
     * `get_manipulator_field_names`
     * `get_manipulator_field_objs`
     * `get_manipulator_fields`
     * `get_manipulator_new_data`
     * `prepare_field_objs_and_params`
     * `get_follow`
   * Renamed `flatten_data` method to `value_to_string` for better alignment with its use by the serialization framework, which was the only remaining code using `flatten_data`.
 * Removed oldforms methods from `django.db.models.Options` class: `get_followed_related_objects`, `get_data_holders`, `get_follow`, and `has_field_type`.
 * Removed oldforms-admin specific options from `django.db.models.fields.related` classes: `num_in_admin`, `min_num_in_admin`, `max_num_in_admin`, `num_extra_on_change`, and `edit_inline`.
 * Serialization framework
   * `Serializer.get_string_value` now calls the model fields' renamed `value_to_string` methods.
   * Removed a special-casing of `models.DateTimeField` in `core.serializers.base.Serializer.get_string_value` that's handled by `django.db.models.fields.DateTimeField.value_to_string`.
 * Removed `django.core.validators`:
   * Moved `ValidationError` exception to `django.core.exceptions`.
   * For the couple places that were using validators, brought over the necessary code to maintain the same functionality.
 * Introduced a SlugField form field for validation and to compliment the SlugField model field (refs #8040).
 * Removed an oldforms-style model creation hack (refs #2160).

git-svn-id: http://code.djangoproject.com/svn/django/trunk@8616 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-27 07:19:44 +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