diff options
| author | nessita <124304+nessita@users.noreply.github.com> | 2023-05-11 07:55:45 -0300 |
|---|---|---|
| committer | Natalia <124304+nessita@users.noreply.github.com> | 2023-05-11 07:56:53 -0300 |
| commit | e50fe33e13f15ddeafd6354817b9d96002559751 (patch) | |
| tree | 9611ecd060c123f18064aaca90419501f2df7ee5 /docs | |
| parent | e0d8981139cd329962e509efb575fdfb2dad4073 (diff) | |
[4.2.x] Made explicit the location of locally-built HTML docs.
Backport of 2b11740e1d9d23ef53d94a1c45896fb7b91df908 from main
Diffstat (limited to '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 ================================== |
