mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-28 16:16:12 +00:00
Code Issues 32 Releases Wiki Activity
33,182 Commits 30 Branches 460 Tags
f810be610b47e44059c471f9d2e96f9a609e9b4f
Commit Graph

75 Commits

Author SHA1 Message Date
Adam Zapletal
e9ed5da3cb Removed trailing whitespace in docs. 2024-11-27 13:13:28 -03:00
Paolo Melchiorre
b5669f08bc Improved the writing documentation contributing guide. 2024-10-25 16:35:35 +02:00
Lance Goyke
a680ac7d77 Restructured writing documentation contributing guide. 
This trims and clearly delineates the how to guide from the subsequent
explanation with additional subheadings.

These changes have been discussed with Daniele Procida
at the DjangoCon US 2023 sprints.
 2023-10-21 09:44:36 +02:00
David Smith
1611577102 Corrected note about using accents in writing documentation contributing guide. 2023-10-21 09:39:16 +02:00
Mariusz Felisiak
295467c04a Removed versionadded/changed annotations for 4.2. 
This also removes remaining versionadded/changed annotations for older
versions.
 2023-09-18 22:12:40 +02:00
nessita
2b11740e1d Made explicit the location of locally-built HTML docs. 2023-05-11 07:55:45 -03:00
Tim Graham
2c4dc64760 Used extlinks for PyPI links. 
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
 2023-04-17 06:55:32 +02:00
django-bot
14459f80ee Fixed #34140 -- Reformatted code blocks in docs with blacken-docs. 2023-03-01 13:03:56 +01:00
Mariusz Felisiak
6015bab80e Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 
This adds:
- GitHub actions,
- tox configuration,
- pre-commit hook, and
- makefile rules
to run blacken-docs linter.

Co-authored-by: David Smith <smithdc@gmail.com>
 2023-03-01 13:02:57 +01:00
Carlton Gibson
534ac48297 Refs #34140 -- Applied rst code-block to non-Python examples. 
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for
reviews.
 2023-02-10 19:19:13 +01:00
Ramil Yanbulatov
c6290bae9d Fixed #33842 -- Used :source: role for links to repo files on GitHub. 2022-08-09 14:44:51 +02:00
Arslan Noor
5c93a84f44 Corrected various typos in contributing docs. 2022-06-30 11:09:06 +02:00
Mariusz Felisiak
653daaa60c Refs #31676 -- Used term "merger" instead of "committer" in docs. 
Follow up to caa2dd08c4.

Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
 2022-03-22 11:13:36 +01:00
David Smith
69b0736fad Refs #32956 -- Changed docs to treat the acronym HTTP phonetically. 2021-10-18 21:00:28 +02:00
David Smith
1024b5e74a Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
David Smith
1cba320786 Refs #32956 -- Changed "afterwards" to "afterward" in docs and comments. 
This also removes unnecessary comments with the previous spelling.

AP Stylebook has a short entry to advise the preferred spelling for
"en-us". "Afterwards" is preferred in British English.
 2021-07-27 10:41:51 +02:00
Nick Pope
0851933cba Fixed #32720 -- Added configuration and docs for Sphinx link checker. 
We explicitly ignore checking anchors for line-range anchors on GitHub
which are dynamically generated and, otherwise, show up as broken links.

See https://github.com/sphinx-doc/sphinx/issues/7388#issuecomment-739961689.

We also ignore links to resources that require authentication.
 2021-05-17 11:21:35 +02:00
Nick Pope
c156e36955 Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS. 2021-05-17 09:46:09 +02:00
Nick Pope
c240ceea7d Fixed typo in docs/internals/contributing/writing-documentation.txt. 2021-05-06 20:01:32 +02:00
David Smith
7514852767 Removed redundant pyenchant dependency in spelling check docs. 2020-06-01 07:07:56 +02:00
Nick Pope
fbdb032de2 Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
Nick Pope
feb91dbda1 Used :mimetype: role in various docs. 2020-05-13 09:14:04 +02:00
Nick Pope
a9337b4add Used :pep: role in various docs. 2020-05-13 09:14:04 +02:00
Mariusz Felisiak
0ac8ac8b0d Refs #25778 -- Updated some links to HTTPS and new locations. 2020-01-29 09:34:37 +01:00
Jon Dufresne
32166a9f7c Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
Jon Dufresne
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
Hasan Ramezani
b1d39131eb Fixed typo in internals/contributing/writing-documentation.txt. 2019-12-03 20:11:54 +01:00
Baptiste Mispelon
42df1b178b Refs #31029 -- Added note about :rfc: role in writing documentation docs. 2019-11-27 20:52:28 +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
Mariusz Felisiak
053ff7e9e6 Fixed typo in docs/internals/contributing/writing-documentation.txt. 2019-09-05 14:06:46 +02:00
Carlton Gibson
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
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
9caa3e0a29 Doc'd a few contributing guidelines. 2019-03-25 18:26:23 -04:00
Brett Cannon
64b74804c5 Fixed #29334 -- Updated pypi.python.org URLs to pypi.org. 2018-04-17 20:24:27 -04:00
Tim Graham
73cb62a331 Fixed links to Sphinx docs. 2018-03-30 14:29:23 -04:00
Roy Zwambag
fe32fe1619 Used console directive in "Writing documentation". 2018-03-07 16:19:22 -05:00
Ramiro Morales
37c17846ad Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
Claude Paroz
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
Philip James
2c90981c5f Fixed #26699 -- Mentioned doc theming difference (locally-built vs. website). 2016-06-02 14:06:56 -04:00
Tim Graham
2e1d44e46d Fixed #26637 -- Removed obsolete note in docs/internals/contributing/writing-documentation.txt 2016-05-19 09:11:56 -04:00
Amine
8b5a4fa941 Fixed a broken link in docs/internals/contributing/writing-documentation.txt. 2016-03-19 16:19:01 -04:00
Tim Graham
460dab0b40 Removed obsolete section on "Improving the documentation". 2016-03-15 19:05:54 -04:00
Elif T. Kus
bca9faae95 Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -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
df3d5b1d73 Fixed #26003 -- Added "how the documentation is organized" sections. 
Thanks Daniele Procida for coauthoring.
 2015-12-31 11:35:00 -05:00
Agnieszka Lasyk
1f8dad6915 Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
Curtis Maloney
35440ceab7 Optimized docs images and documented the process. 2015-10-24 14:57:21 -04:00
Tim Graham
aed437d567 Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
Tim Graham
ccfb5c7408 Removed obsolete literals_to_xrefs.py script. 2015-06-15 10:22:18 -04:00
Steadman
dfdcb3ca22 Improved wording in writing documentation docs. 2015-06-04 11:58:32 +01:00