Removed playdoh docs from docs/ and made it a template for the forked…

… projects. Playdoh docs now live under gh.com/mozilla/playdoh-docs Closes issue 31.
Osmose · Jun 9, 2011 · c6a1c1b · c6a1c1b
1 parent c6d7e2a
commit c6a1c1b
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 833 deletions.
diff --git a/docs/bestpractices.rst b/docs/bestpractices.rst
diff --git a/docs/build-github.zsh b/docs/build-github.zsh
@@ -1,5 +1,8 @@
 #!/bin/zsh
 
+# A useful build script for projects hosted on github:
+# It can build your Sphinx docs and push them straight to your gh-pages branch.
+
 # Should be run from the docs directory: (cd docs && ./build-github.zsh)
 
 REPO=$(git config remote.origin.url)

diff --git a/docs/conf.py b/docs/conf.py
@@ -40,8 +40,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'playdoh'
-copyright = u'2011, Mozilla'
+project = u'a playdoh-based project'
+copyright = u'2011, the authors'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -211,8 +211,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'playdoh', u'playdoh Documentation',
-     [u'Mozilla'], 1)
+    ('index', 'a-playdoh-app', u"a-playdoh-app's Documentation",
+     [u'the authors'], 1)
 ]
 
 

diff --git a/docs/docs.rst b/docs/docs.rst
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,50 +1,26 @@
-===================================
-Welcome to playdoh's documentation!
-===================================
+========================================
+Welcome to this project's documentation!
+========================================
 
-**Mozilla's Playdoh** is a web application template based on Django_.
+This is a documentation template for a **web application based on Playdoh**.
+Feel free to change this to your liking.
 
-Patches are welcome! Feel free to fork and contribute to this project on
-Github_.
 
-.. _Django: http://www.djangoproject.com/
-.. _Github: https://github.com/mozilla/playdoh
+About playdoh
+-------------
 
+This project is based on **playdoh**. Mozilla's Playdoh is an open source
+web application template based on `Django <http://www.djangoproject.com/>`_.
 
-Features
---------
-Quick and dirty (and probably incomplete) feature list:
-
-* Rich, but "cherry-pickable" features out of the box:
-
-  * Django
-  * jinja2 template engine
-  * Celery support
-  * Simple database migrations
-  * Full localization support
-
-* Secure by default:
-
-  * SHA-512 default password hashing
-  * X-Frame-Options: DENY by default
-  * secure and httponly flags on cookies enabled by default
-
+To learn more about it, step by the `playdoh project page
+<https://github.com/mozilla/playdoh>`_.
 
 Contents
 --------
 
 .. toctree::
    :maxdepth: 1
 
-   gettingstarted
-   libs
-   operations
-   migrations
-   l10n
-   packages
-   docs
-   bestpractices
-
 
 Indices and tables
 ------------------