74baa468e0
[3.1.x] Removed redundant pyenchant dependency in spelling check docs.
...
Backport of 7514852767
2020-06-01 07:08:25 +02:00
4eb5e4ee4f
[3.1.x] Used :envvar: role and .. envvar:: directive in various docs.
...
Backport of fbdb032de2
2020-05-13 09:38:59 +02:00
345fa40cb5
[3.1.x] Used :mimetype: role in various docs.
...
Backport of feb91dbda1
2020-05-13 09:38:49 +02:00
15d76dc2ab
[3.1.x] Used :pep: role in various docs.
...
Backport of a9337b4add
2020-05-13 09:38:40 +02:00
0ac8ac8b0d
Refs #25778 -- Updated some links to HTTPS and new locations.
2020-01-29 09:34:37 +01:00
32166a9f7c
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
5708327c37
Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin.
...
Unify on the entry point created by setuptools entry_points feature.
2019-12-06 12:11:44 +01:00
b1d39131eb
Fixed typo in internals/contributing/writing-documentation.txt.
2019-12-03 20:11:54 +01:00
42df1b178b
Refs #31029 -- Added note about :rfc: role in writing documentation docs.
2019-11-27 20:52:28 +01:00
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
053ff7e9e6
Fixed typo in docs/internals/contributing/writing-documentation.txt.
2019-09-05 14:06:46 +02:00
ed2d411aa8
Refs #30573 -- Noted to avoid "simple" & co. in Writing Style guide.
...
Co-authored-by: Tobias Kunze <r@rixx.de>
2019-09-05 10:13:31 +02:00
aed89adad5
Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints.
2019-04-18 14:41:15 +02:00
9caa3e0a29
Doc'd a few contributing guidelines.
2019-03-25 18:26:23 -04:00
64b74804c5
Fixed #29334 -- Updated pypi.python.org URLs to pypi.org.
2018-04-17 20:24:27 -04:00
73cb62a331
Fixed links to Sphinx docs.
2018-03-30 14:29:23 -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
01f658644a
Updated various links in docs to avoid redirects
...
Thanks Tim Graham and Mariusz Felisiak for review and completion.
2017-05-22 19:28:44 +02:00
2c90981c5f
Fixed #26699 -- Mentioned doc theming difference (locally-built vs. website).
2016-06-02 14:06:56 -04:00
2e1d44e46d
Fixed #26637 -- Removed obsolete note in docs/internals/contributing/writing-documentation.txt
2016-05-19 09:11:56 -04:00
8b5a4fa941
Fixed a broken link in docs/internals/contributing/writing-documentation.txt.
2016-03-19 16:19:01 -04:00
460dab0b40
Removed obsolete section on "Improving the documentation".
2016-03-15 19:05:54 -04:00
bca9faae95
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05: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
df3d5b1d73
Fixed #26003 -- Added "how the documentation is organized" sections.
...
Thanks Daniele Procida for coauthoring.
2015-12-31 11:35:00 -05:00
1f8dad6915
Fixed #25755 -- Unified spelling of "website".
2015-11-16 06:44:14 -05:00
35440ceab7
Optimized docs images and documented the process.
2015-10-24 14:57:21 -04:00
aed437d567
Updated release process for new release schedule.
2015-06-25 11:36:17 -04:00
ccfb5c7408
Removed obsolete literals_to_xrefs.py script.
2015-06-15 10:22:18 -04:00
dfdcb3ca22
Improved wording in writing documentation docs.
2015-06-04 11:58:32 +01:00
f66c2bdc0f
Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage
2015-03-10 08:12:09 -04:00
9ec8aa5e5d
Fixed #24149 -- Normalized tuple settings to lists.
2015-02-03 14:59:45 -05:00
7102b99653
Added best practices for versionadded/changed annotations.
2015-01-09 13:23:29 -05:00
37b13033c6
Removed sudo from pip commands in docs.
2014-09-22 15:49:48 -04:00
fca677fa43
Added sphinx extension to ease generation of ticket links.
2014-08-19 17:40:50 -04:00
0efd72dc90
Fixed broken links in docs.
2014-08-05 08:23:34 -04:00
1a3bec4a26
Fixed #18108 -- Added instructions for translating documentation.
...
Thanks Claude Paroz.
2014-07-02 13:16:31 -04:00
61960dd02c
Added a patch review checklist.
2014-06-03 11:55:17 -04:00
11d453bcad
Various documentation typo/spelling fixes
...
Errors detected by Topy (https://github.com/intgr/topy ), all changes
verified by hand.
2014-04-23 02:31:49 +03:00
a0f2525202
Fixed #22141 -- Added a spelling checker for documentation.
2014-03-07 09:29:23 -05:00
bed52afee7
Removed usage of to-be-deprecated ADMIN_FOR setting in contributing docs
2013-12-14 16:49:25 +01:00
c0a2daad78
Documented the house style for gender neutral pronouns.
2013-11-30 08:31:58 -05:00
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
4d13cc56de
Fixed #21035 -- Changed docs to treat the acronym SQL phonetically.
...
The documentation and comments now all use 'an' to
refer to the word SQL and not 'a'.
2013-09-05 20:14:58 -04:00
f8297f6323
More migration docs, and conversion of all easy syncdb references
2013-07-25 16:19:36 +01: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
5c143cb340
Fixed #19180 - Clarified policy regarding older versions of the docs.
2012-10-25 17:55:42 -04:00
8a5d1a6b93
Updated obsolete links in the documentation
2012-06-28 10:49:07 +02:00
87ff89d12d
Fixed #17933 -- Added intro note to writing-documentation.txt
...
Based on initial patch by Thomas Westfeld
2012-06-07 11:32:28 -05:00
David Smith
Nick Pope
Mariusz Felisiak
Jon Dufresne
Hasan Ramezani
Baptiste Mispelon
Tobias Kunze
Carlton Gibson
Ramiro Morales
Tim Graham
Brett Cannon
Roy Zwambag
Ramiro Morales
Claude Paroz
Philip James
Amine
Elif T. Kus
Agnieszka Lasyk
Curtis Maloney
Steadman
Erik Romijn
darkryder
Corey Farwell
Marti Raudsepp
Szczepan Cieślik
Bouke Haarsma
Alex Gaynor
Rogério Yokomizo
Eric Boersma
Andrew Godwin
Juan Catalano
Adrian Holovaty