Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Fixes #17933 #116

Closed
wants to merge 1 commit into from

2 participants

Thomas Westfeld Adrian Holovaty
Thomas Westfeld

added link to check out documentation to "Writing documentation" page

One can argue about placing this information on the bottom of the page to ensure that possible contributors read the docs first. One the other hand checking out the code is the first step to get started.

Thomas Westfeld Fixed #17933 -- added link to check out documentation
added link to check out documentation to "Writing documentation" page
ed16913
Adrian Holovaty
Collaborator

Thanks, Thomas. I rewrote this a fair bit and committed it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jun 7, 2012
  1. Fixed #17933 -- added link to check out documentation

    Thomas Westfeld authored
    added link to check out documentation to "Writing documentation" page
This page is out of date. Refresh to see the latest.
12 docs/internals/contributing/writing-documentation.txt
View
@@ -18,6 +18,17 @@ Documentation changes generally come in two forms:
This section explains how writers can craft their documentation changes
in the most useful and least error-prone ways.
+
+.. _getting-the-documentation-code:
+
+Getting the documentation code
+------------------------------
+To get started improving or writing documentation, get the development version
+of Django from the source code repository (see :ref:`installing-development-version`).
+The documentation is usually only revised in trunk, as it is frozen for
+existing releases (see :ref:`differences-between-doc-versions`).
+
+
Getting started with Sphinx
---------------------------
@@ -311,3 +322,4 @@ look better:
(that's a tilde) to get just the "last bit" of that path. So
``:class:`~django.contrib.contenttypes.models.ContentType``` will just
display a link with the title "ContentType".
+
2  docs/intro/whatsnext.txt
View
@@ -191,6 +191,8 @@ You can get a local copy of the HTML documentation following a few easy steps:
__ http://sphinx.pocoo.org/
__ http://www.gnu.org/software/make/
+.. _differences-between-doc-versions:
+
Differences between versions
============================
Something went wrong with that request. Please try again.