mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-06-05 03:29:12 +00:00
Code Issues 32 Releases Wiki Activity

Made explicit the location of locally-built HTML docs.

Browse Source
This commit is contained in:
nessita 2023-05-11 07:55:45 -03:00 committed by GitHub
parent ffff17d4b0
commit 2b11740e1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/internals/contributing/writing-documentation.txt
View File

@ -60,10 +60,11 @@ Then from the ``docs`` directory, build the HTML:
To get started contributing, you'll want to read the :ref:`reStructuredText To get started contributing, you'll want to read the :ref:`reStructuredText
reference <sphinx:rst-index>`. reference <sphinx:rst-index>`.
Your locally-built documentation will be themed differently than the Your locally-built documentation will be accessible at
documentation at `docs.djangoproject.com <https://docs.djangoproject.com/>`_. ``docs/_build/html/index.html`` and it can be viewed in any web browser, though
This is OK! If your changes look good on your local machine, they'll look good it will be themed differently than the documentation at
on the website. `docs.djangoproject.com <https://docs.djangoproject.com/>`_. This is OK! If
your changes look good on your local machine, they'll look good on the website.
How the documentation is organized How the documentation is organized
================================== ==================================