1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
Mark Walker 4eb4ab4122 Reorganized the Contributing to Django docs.
This work follows a comprehensive review conducted during the DjangoCon US 2023
sprints. Changes include:
 - Updated the title of the main page for better alignment with the content.
 - Removed emojis to enhance accessibility and avoid cultural specificity.
 - Improved the layout and navigation of contributing documentation.
 - Unified sections for communication channels and community links.
 - Grouped resources according to the Diátaxis systematic approach.

Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
Co-authored-by: Daniele Procida <daniele@vurt.org>
2024-01-11 22:25:27 -03:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme
faq Updated examples for 2.0+ release numbering in installation FAQ. 2023-12-15 06:16:02 +01:00
howto Refs #25778 -- Updated some links and references to HTTPS. 2023-11-29 11:21:22 +01:00
internals Reorganized the Contributing to Django docs. 2024-01-11 22:25:27 -03:00
intro Fixed #35084 -- Recommended 'django_' prefix for reusable app modules. 2024-01-04 09:54:37 +01:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc Refs #25778 -- Updated some links and references to HTTPS. 2023-11-29 11:21:22 +01:00
ref Fixed #35092 -- Exposed extra fields for GeoIP2.country() and GeoIP2.city() responses. 2024-01-10 12:09:44 +01:00
releases Fixed #35100 -- Reworked GeoIP2 database initialization. 2024-01-11 12:01:35 +01:00
topics Made management command examples more consistent in docs. 2024-01-09 20:12:14 +01:00
conf.py Bumped version; main is now 5.1 pre-alpha. 2023-09-18 22:12:40 +02:00
contents.txt
glossary.txt
index.txt Reorganized the Contributing to Django docs. 2024-01-11 22:25:27 -03:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
README.rst
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Fixed #35075 -- Added deduplicate_items parameter to BTreeIndex. 2024-01-02 12:55:12 +01:00

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
This allows it to be built into other forms for easier viewing and browsing.

To create an HTML version of the docs:

* Install Sphinx (using ``python -m pip install Sphinx`` or some other method).

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt.

The documentation in ``_build/html/index.html`` can then be viewed in a web
browser.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/