[#616] Add new index documents for toctree and small text tweaks

ckan · Apr 2, 2013 · f779fd7 · f779fd7
1 parent 141d08c
commit f779fd7
Show file tree

Hide file tree

Showing 11 changed files with 119 additions and 103 deletions.
diff --git a/doc/_templates/footer.html b/doc/_templates/footer.html
@@ -9,7 +9,7 @@
 <p>
 <a href="https://github.com/okfn/ckan">Source</a>
 &mdash;
-<a href="https://trac.ckan.org/">Issues</a>
+<a href="https://github.com/okfn/ckan/issues">Issues</a>
 &mdash;
 <a href="http://lists.okfn.org/mailman/listinfo/ckan-dev">Mailing List</a>
 &mdash;

diff --git a/doc/conf.py b/doc/conf.py
@@ -44,7 +44,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'CKAN Data Management System Documentation'
+project = u'CKAN Documentation'
 project_short_name = u'CKAN'
 copyright = u'''&copy; 2009-2012, <a href="http://okfn.org/">Open Knowledge Foundation</a>.
     Licensed under <a

diff --git a/doc/index-admin.rst b/doc/index-admin.rst
@@ -0,0 +1,12 @@
+======================
+General Administration
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+   administrative-dashboard
+   paster
+   database-dumps
+   configuration
+   common-error-messages
diff --git a/doc/index-api.rst b/doc/index-api.rst
@@ -0,0 +1,11 @@
+============
+The CKAN API
+============
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   datastore-api
+   filestore-api
+   legacy-api
diff --git a/doc/index-customizing.rst b/doc/index-customizing.rst
@@ -0,0 +1,23 @@
+=========================
+Customizing and Extending
+=========================
+
+.. toctree::
+   :maxdepth: 2
+
+   theming
+   apps-ideas
+   commenting
+   extensions
+   writing-extensions
+   toolkit
+   tag-vocabularies
+   form-integration
+   linked-data-and-rdf
+   filestore
+   datastore
+   background-tasks
+   harvesting
+   geospatial
+   multilingual
+   email-notifications
diff --git a/doc/index-for-developers.rst b/doc/index-for-developers.rst
@@ -0,0 +1,15 @@
+===================
+For CKAN Developers
+===================
+
+.. toctree::
+   :maxdepth: 2
+
+   architecture
+   python-coding-standards
+   javascript-coding-standards
+   html-coding-standards
+   css-coding-standards
+   i18n
+   test
+   release-cycle
diff --git a/doc/index-indices.rst b/doc/index-indices.rst
@@ -0,0 +1,10 @@
+==================
+Indices and tables
+==================
+
+.. toctree::
+   :maxdepth: 1
+
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`
diff --git a/doc/index-install.rst b/doc/index-install.rst
@@ -0,0 +1,13 @@
+============
+Installation
+============
+
+.. toctree::
+   :maxdepth: 2
+
+   install-from-package
+   install-from-source
+   post-installation
+   deployment
+   solr-setup
+   datastore-setup
diff --git a/doc/index-other-material.rst b/doc/index-other-material.rst
@@ -0,0 +1,9 @@
+==============
+Other material
+==============
+
+.. toctree::
+   :maxdepth: 1
+
+   contrib.rst
+   CHANGELOG.rst
diff --git a/doc/index-publishing.rst b/doc/index-publishing.rst
@@ -0,0 +1,12 @@
+===================
+Publishing Datasets
+===================
+
+.. toctree::
+   :maxdepth: 2
+
+   publishing-datasets
+   loading-data
+   authorization
+   publisher-profile
+   data-viewer
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,119 +1,30 @@
-=======================================
-Welcome to CKAN's Administration Guide
-=======================================
+===============================
+Welcome to CKAN's Documentation
+===============================
 
 .. note ::
 
    This is the documentation for CKAN version '|version|'. If you are using a different version, use the links on the bottom right corner of the page to select the appropriate documentation.
 
-This Administration Guide covers how to set up and manage `CKAN <http://ckan.org>`_ software.
+This documentation covers how to set up and manage `CKAN <http://ckan.org>`_ software.
 
 * The first two sections cover your two options for installing CKAN: package or source install.
 * The rest of the first half of the Guide, up to :doc:`authorization`, covers setup and basic admin.
 * The second half of the Guide, from :doc:`extensions` onwards, covers advanced tasks, including extensions and forms.
 
 For high-level information on what CKAN is, see the `CKAN website <http://ckan.org>`_.
 
-Installation
-============
-
-.. toctree::
-   :maxdepth: 3
-
-   install-from-package
-   install-from-source
-   post-installation
-   deployment
-   solr-setup
-   datastore-setup
-
-Customizing and Extending
-=========================
-
-.. toctree::
-   :maxdepth: 2
-
-   theming
-   apps-ideas
-   commenting
-   extensions
-   writing-extensions
-   toolkit
-   tag-vocabularies
-   form-integration
-   linked-data-and-rdf
-   filestore
-   datastore
-   background-tasks
-   harvesting
-   geospatial
-   multilingual
-   email-notifications
-
-Publishing Datasets
-===================
-
 .. toctree::
    :maxdepth: 2
 
-   publishing-datasets
-   loading-data
-   authorization
-   publisher-profile
-   data-viewer
-
-The CKAN API
-============
-
-.. toctree::
-   :maxdepth: 1
-
-   api
-   datastore-api
-   filestore-api
-   legacy-api
-
-
-General Administration
-======================
-
-.. toctree::
-   :maxdepth: 2
-
-   administrative-dashboard
-   paster
-   database-dumps
-   configuration
-   common-error-messages
-
-For CKAN Developers
-===================
-
-.. toctree::
-   :maxdepth: 1
-
-   architecture
-   python-coding-standards
-   javascript-coding-standards
-   html-coding-standards
-   css-coding-standards
-   i18n
-   test
-   release-cycle
-
-Other material
-==============
-
-.. toctree::
-   :maxdepth: 2
-
-   contrib.rst
-   CHANGELOG.rst
-
-Indices and tables
-==================
+   index-install
+   index-customizing
+   index-publishing
+   index-api
+   index-admin
+   index-for-developers
+   index-other-material
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
-
+* :ref:`search`