Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

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.

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

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

Adrian Holovaty adrianholovaty closed this June 07, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Showing 1 unique commit by 1 author.

Jun 07, 2012
Fixed #17933 -- added link to check out documentation
added link to check out documentation to "Writing documentation" page
ed16913
This page is out of date. Refresh to see the latest.
12  docs/internals/contributing/writing-documentation.txt
@@ -18,6 +18,17 @@ Documentation changes generally come in two forms:
18 18
 This section explains how writers can craft their documentation changes
19 19
 in the most useful and least error-prone ways.
20 20
 
  21
+
  22
+.. _getting-the-documentation-code:
  23
+
  24
+Getting the documentation code
  25
+------------------------------
  26
+To get started improving or writing documentation, get the development version
  27
+of Django from the source code repository (see :ref:`installing-development-version`).
  28
+The documentation is usually only revised in trunk, as it is frozen for
  29
+existing releases (see :ref:`differences-between-doc-versions`).
  30
+
  31
+
21 32
 Getting started with Sphinx
22 33
 ---------------------------
23 34
 
@@ -311,3 +322,4 @@ look better:
311 322
   (that's a tilde) to get just the "last bit" of that path. So
312 323
   ``:class:`~django.contrib.contenttypes.models.ContentType``` will just
313 324
   display a link with the title "ContentType".
  325
+
2  docs/intro/whatsnext.txt
@@ -191,6 +191,8 @@ You can get a local copy of the HTML documentation following a few easy steps:
191 191
 __ http://sphinx.pocoo.org/
192 192
 __ http://www.gnu.org/software/make/
193 193
 
  194
+.. _differences-between-doc-versions:
  195
+
194 196
 Differences between versions
195 197
 ============================
196 198
 
Commit_comment_tip

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.