mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-09 17:02:43 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Lance Goyke 9a5b84ba57 [5.0.x] 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.

Backport of a680ac7d775ba1bdbbda03094a4a64596864421c from main
2023-10-21 16:56:16 +02:00
..
_ext
Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+.
2023-08-03 08:01:06 +02:00
_theme
Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-05-31 11:17:01 +02:00
faq
Fixed #34545 -- Corrected the number of months in installation FAQ.
2023-05-08 08:34:23 +02:00
howto
Fixed typo in docs/howto/custom-file-storage.txt.
2023-09-16 07:03:10 +02:00
internals
[5.0.x] Restructured writing documentation contributing guide.
2023-10-21 16:56:16 +02:00
intro
[5.0.x] Reorganized tutorial's part 4 to better understand changes needed in URLConf.
2023-10-10 14:05:36 -03:00
man
Updated man page for Django 5.0 alpha.
2023-09-18 09:25:34 -03:00
misc
…
ref
[5.0.x] Fixed #34808 -- Doc'd aggregate function's default argument.
2023-10-11 16:10:30 -03:00
releases
[5.0.x] Fixed #34798 -- Fixed QuerySet.aggregate() crash when referencing expressions containing subqueries.
2023-10-16 06:15:08 +02:00
topics
[5.0.x] Fixed #34808 -- Doc'd aggregate function's default argument.
2023-10-11 16:10:30 -03:00
conf.py
[5.0.x] Bumped django_next_version in docs config.
2023-09-18 11:28:22 -03:00
contents.txt
…
glossary.txt
…
index.txt
Added Django Forum to mailing lists page.
2023-03-24 08:32:17 +01: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
Added Uyghur language.
2023-08-12 20:37:15 +02:00

README.rst 

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/