[mapserver-commits] r8320 - trunk/docs/development
svn at osgeo.org
svn at osgeo.org
Mon Dec 29 13:29:39 EST 2008
Author: hobu
Date: 2008-12-29 13:29:39 -0500 (Mon, 29 Dec 2008)
New Revision: 8320
Added:
trunk/docs/development/documentation.txt
Removed:
trunk/docs/development/doc_style_guide.txt
Modified:
trunk/docs/development/index.txt
Log:
rename
Deleted: trunk/docs/development/doc_style_guide.txt
===================================================================
--- trunk/docs/development/doc_style_guide.txt 2008-12-29 18:28:28 UTC (rev 8319)
+++ trunk/docs/development/doc_style_guide.txt 2008-12-29 18:29:39 UTC (rev 8320)
@@ -1,119 +0,0 @@
-*****************************************************************************
- Documentation Style Guide
-*****************************************************************************
-
-:Author: Howard Butler
-:Contact: hobu.inc at gmail.com
-:Author: Jeff McKenna
-:Contact: jmckenna at gatewaygeomatics.com
-:Revision: $Revision$
-:Date: $Date$
-:Last Updated: 2008/12/29
-
-.. contents:: Table of Contents
- :depth: 2
- :backlinks: top
-
-Background
-----------
-
-The current structure of the MapServer documentation process is for
-developers with :ref:`SVN` commit access to maintain their documents
-in reStructuredText format, and therefore all documents live in the
-/docs directory in SVN. The `Sphinx`_ documentation generator is
-used to convert the reStructuredText files to html, and the live
-website is then updated on an hourly basis.
-
-General Guidelines
-------------------
-
-* MapServer instead of mapserver, map server, Map Server or map Server.
-* MapScript instead of mapscript, Mapscript, or map script.
-* PostGIS instead of postgis.
-* HowTo instead of howto or HOWTO.
-* Email addresses should be manually spam protected:
-
- ::
-
- hobu.inc at gmail.com instead of hobu.inc at gmail.com
-
-reStructuredText Reference Guides
----------------------------------
-
-* `Quick reStructuredText`_
-
-reStructuredText Formatting
----------------------------
-
-* All text should be hard breaks at or around the 80 column mark, just as
- the source code.
-* No ``.. sectnum::`` in the contents directives
-* All external links should live at the bottom of your document, under
- the heading:
-
- ::
-
- .. #### rST Link Section ####
-* Always include and update the 'Last Updated:' date at the top of your
- document
-
-Installing Sphinx for rst-html Generation
------------------------------------------
-
-#. install `Python 2.X`_
-#. download `setuptools`_
-#. For Windows users: make sure that the 'C:\Python2X\Scripts'
- directory is your path
-#. execute the following at commandline:
-
- ::
-
- easy_install Sphinx
-
- ...you should see message: "Finished processing dependencies for Sphinx"
-#. inside the /docs directory, create \build\doctrees and \build\html
- directories
-#. inside the /docs directory, execute:
-
- ::
-
- sphinx-build -b html -d build\doctrees . build\html
-
- ...you should see a message: "build succeeded, ..."
-
-Alternatively, if you are on *nix, you can issue
-
-::
- make html
-
-or
-
-::
- make latex
-
-to build the documentation using `make`.
-
-Reference Labels
-----------------
-
-.. include:: ../include/labels.inc
-
-
-Regenerating the reference labels
-..................................
-
-You can regenerate the reference labels by issuing:
-
-::
- make labels
-
-from the docs directory like when you are building the html or latex versions
-
-.. #### rST Link Section ####
-
-.. _`Sphinx`: http://sphinx.pocoo.org/index.html
-.. _`Quick reStructuredText`: http://docutils.sourceforge.net/docs/user/rst/quickref.html
-.. _`setuptools`: http://pypi.python.org/pypi/setuptools#windows
-.. _`Python 2.X`: http://www.python.org/
-
-
Copied: trunk/docs/development/documentation.txt (from rev 8319, trunk/docs/development/doc_style_guide.txt)
===================================================================
--- trunk/docs/development/documentation.txt (rev 0)
+++ trunk/docs/development/documentation.txt 2008-12-29 18:29:39 UTC (rev 8320)
@@ -0,0 +1,121 @@
+.. _documentation_development:
+
+*****************************************************************************
+ Documentation Development Guide
+*****************************************************************************
+
+:Author: Howard Butler
+:Contact: hobu.inc at gmail.com
+:Author: Jeff McKenna
+:Contact: jmckenna at gatewaygeomatics.com
+:Revision: $Revision$
+:Date: $Date$
+:Last Updated: 2008/12/29
+
+.. contents:: Table of Contents
+ :depth: 2
+ :backlinks: top
+
+Background
+----------
+
+The current structure of the MapServer documentation process is for
+developers with :ref:`SVN` commit access to maintain their documents
+in reStructuredText format, and therefore all documents live in the
+/docs directory in SVN. The `Sphinx`_ documentation generator is
+used to convert the reStructuredText files to html, and the live
+website is then updated on an hourly basis.
+
+General Guidelines
+------------------
+
+* MapServer instead of mapserver, map server, Map Server or map Server.
+* MapScript instead of mapscript, Mapscript, or map script.
+* PostGIS instead of postgis.
+* HowTo instead of howto or HOWTO.
+* Email addresses should be manually spam protected:
+
+ ::
+
+ hobu.inc at gmail.com instead of hobu.inc at gmail.com
+
+reStructuredText Reference Guides
+---------------------------------
+
+* `Quick reStructuredText`_
+
+reStructuredText Formatting
+---------------------------
+
+* All text should be hard breaks at or around the 80 column mark, just as
+ the source code.
+* No ``.. sectnum::`` in the contents directives
+* All external links should live at the bottom of your document, under
+ the heading:
+
+ ::
+
+ .. #### rST Link Section ####
+* Always include and update the 'Last Updated:' date at the top of your
+ document
+
+Installing Sphinx for rst-html Generation
+-----------------------------------------
+
+#. install `Python 2.X`_
+#. download `setuptools`_
+#. For Windows users: make sure that the 'C:\Python2X\Scripts'
+ directory is your path
+#. execute the following at commandline:
+
+ ::
+
+ easy_install Sphinx
+
+ ...you should see message: "Finished processing dependencies for Sphinx"
+#. inside the /docs directory, create \build\doctrees and \build\html
+ directories
+#. inside the /docs directory, execute:
+
+ ::
+
+ sphinx-build -b html -d build\doctrees . build\html
+
+ ...you should see a message: "build succeeded, ..."
+
+Alternatively, if you are on *nix, you can issue
+
+::
+ make html
+
+or
+
+::
+ make latex
+
+to build the documentation using `make`.
+
+Reference Labels
+----------------
+
+.. include:: ../include/labels.inc
+
+
+Regenerating the reference labels
+..................................
+
+You can regenerate the reference labels by issuing:
+
+::
+ make labels
+
+from the docs directory like when you are building the html or latex versions
+
+.. #### rST Link Section ####
+
+.. _`Sphinx`: http://sphinx.pocoo.org/index.html
+.. _`Quick reStructuredText`: http://docutils.sourceforge.net/docs/user/rst/quickref.html
+.. _`setuptools`: http://pypi.python.org/pypi/setuptools#windows
+.. _`Python 2.X`: http://www.python.org/
+
+
Modified: trunk/docs/development/index.txt
===================================================================
--- trunk/docs/development/index.txt 2008-12-29 18:28:28 UTC (rev 8319)
+++ trunk/docs/development/index.txt 2008-12-29 18:29:39 UTC (rev 8320)
@@ -11,7 +11,7 @@
sponsors
bugs
svn
- doc_style_guide
+ documentation
tests/index
rfc/index
editing/index
More information about the mapserver-commits
mailing list