diff options
author | nessita <124304+nessita@users.noreply.github.com> | 2023-05-11 07:55:45 -0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-11 07:55:45 -0300 |
commit | 2b11740e1d9d23ef53d94a1c45896fb7b91df908 (patch) | |
tree | 9500e8fef3432ae4dc9203a2c2c847cb9bfc9179 | |
parent | ffff17d4b0117cce59f65c9f56fa164694eafd23 (diff) | |
download | django-2b11740e1d9d23ef53d94a1c45896fb7b91df908.tar.gz |
Made explicit the location of locally-built HTML docs.
-rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 73147c82bf..fa3cd749f9 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -60,10 +60,11 @@ Then from the ``docs`` directory, build the HTML: To get started contributing, you'll want to read the :ref:`reStructuredText reference <sphinx:rst-index>`. -Your locally-built documentation will be themed differently than the -documentation at `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. +Your locally-built documentation will be accessible at +``docs/_build/html/index.html`` and it can be viewed in any web browser, though +it will be themed differently than the documentation at +`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 ================================== |