summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-documentation.txt
AgeCommit message (Collapse)Author
2026-01-30Added documentation on reviewing patches.Tim Schilling
Original inspiration drawn from Sarah Boyce's talk: "Django needs you! (to do code review)"
2026-01-29Made explicit that aspell is a requirement to run spell checks on docs.Natalia
2026-01-19Fixed unbalanced parentheses in docs.Clifford Gama
2025-12-22Fixed #36305 -- Added documentation indentation guidelines to contributing docs.ankan0503
2025-08-25Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.David Smith
The `check` docs target now runs spelling, black, and lint, so all current documentation quality checks can be run with a single command. Also documented the lint-docs check's availability and usage.
2025-08-25Refs #36485 -- Rewrapped docs to 79 columns line length.David Smith
Lines in the docs files were manually adjusted to conform to the 79 columns limit per line (plus newline), improving readability and consistency across the content.
2025-08-25Refs #36485 -- Fixed dangling hyphen and unbalanced inline markup in docs.David Smith
2025-08-05Refs #36485 -- Grouped docs checks under a unified make check target.David Smith
Added a new 'check' rule to the docs Makefile which runs both the black and spelling checks.
2025-08-05Refs #34140 -- Added dedicated code block formatting section in ↵David Smith
docs/internals/contributing/writing-documentation.txt.
2025-03-21Fixed #36138 -- Changed ADMINS and MANAGERS settings to lists of strings.Mike Edmunds
Previously, the ADMINS and MANAGERS settings were lists of (name, address) tuples (where the name had been unused). Deprecated use of tuples. Updated settings value sanity checks, and changed from ValueError to ImproperlyConfigured.
2024-11-27Removed trailing whitespace in docs.Adam Zapletal
2024-10-25Improved the writing documentation contributing guide.Paolo Melchiorre
2023-10-21Restructured writing documentation contributing guide.Lance Goyke
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-21Corrected note about using accents in writing documentation contributing guide.David Smith
2023-09-18Removed versionadded/changed annotations for 4.2.Mariusz Felisiak
This also removes remaining versionadded/changed annotations for older versions.
2023-05-11Made explicit the location of locally-built HTML docs.nessita
2023-04-17Used extlinks for PyPI links.Tim Graham
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-03-01Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.django-bot
2023-03-01Refs #34140 -- Added configurations to run blacken-docs linter and adjusted ↵Mariusz Felisiak
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-02-10Refs #34140 -- Applied rst code-block to non-Python examples.Carlton Gibson
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for reviews.
2022-08-09Fixed #33842 -- Used :source: role for links to repo files on GitHub.Ramil Yanbulatov
2022-06-30Corrected various typos in contributing docs.Arslan Noor
2022-03-22Refs #31676 -- Used term "merger" instead of "committer" in docs.Mariusz Felisiak
Follow up to caa2dd08c4722c8702588f5dfe1fa4c506aa66fc. Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2021-10-18Refs #32956 -- Changed docs to treat the acronym HTTP phonetically.David Smith
2021-07-29Fixed 32956 -- Lowercased spelling of "web" and "web framework" where ↵David Smith
appropriate.
2021-07-27Refs #32956 -- Changed "afterwards" to "afterward" in docs and comments.David Smith
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-05-17Fixed #32720 -- Added configuration and docs for Sphinx link checker.Nick Pope
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-17Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS.Nick Pope
2021-05-06Fixed typo in docs/internals/contributing/writing-documentation.txt.Nick Pope
2020-06-01Removed redundant pyenchant dependency in spelling check docs.David Smith
2020-05-13Used :envvar: role and .. envvar:: directive in various docs.Nick Pope
2020-05-13Used :mimetype: role in various docs.Nick Pope
2020-05-13Used :pep: role in various docs.Nick Pope
2020-01-29Refs #25778 -- Updated some links to HTTPS and new locations.Mariusz Felisiak
2020-01-29Refs #25778 -- Updated sphinx-doc.org links to HTTPS.Jon Dufresne
2019-12-06Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin.Jon Dufresne
Unify on the entry point created by setuptools entry_points feature.
2019-12-03Fixed typo in internals/contributing/writing-documentation.txt.Hasan Ramezani
2019-11-27Refs #31029 -- Added note about :rfc: role in writing documentation docs.Baptiste Mispelon
2019-09-06Fixed #30573 -- Rephrased documentation to avoid words that minimise the ↵Tobias Kunze
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-05Fixed typo in docs/internals/contributing/writing-documentation.txt.Mariusz Felisiak
2019-09-05Refs #30573 -- Noted to avoid "simple" & co. in Writing Style guide.Carlton Gibson
Co-authored-by: Tobias Kunze <r@rixx.de>
2019-04-18Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, ↵Ramiro Morales
comments and hints.
2019-03-25Doc'd a few contributing guidelines.Tim Graham
2018-04-17Fixed #29334 -- Updated pypi.python.org URLs to pypi.org.Brett Cannon
2018-03-30Fixed links to Sphinx docs.Tim Graham
2018-03-07Used console directive in "Writing documentation".Roy Zwambag
2018-01-20Fixed #28343 -- Add an OS chooser for docs command line examples.Ramiro Morales
2017-05-22Updated various links in docs to avoid redirectsClaude Paroz
Thanks Tim Graham and Mariusz Felisiak for review and completion.
2016-06-02Fixed #26699 -- Mentioned doc theming difference (locally-built vs. website).Philip James
2016-05-19Fixed #26637 -- Removed obsolete note in ↵Tim Graham
docs/internals/contributing/writing-documentation.txt
generated by cgit v1.3 (git 2.53.0) at 2026-07-02 22:54:08 +0000