From f779fd7f499904cdf5a6d47f6f820384b2c1f7fc Mon Sep 17 00:00:00 2001 From: John Martin Date: Tue, 2 Apr 2013 13:02:20 +0100 Subject: [PATCH] [#616] Add new index documents for toctree and small text tweaks --- doc/_templates/footer.html | 2 +- doc/conf.py | 2 +- doc/index-admin.rst | 12 ++++ doc/index-api.rst | 11 ++++ doc/index-customizing.rst | 23 +++++++ doc/index-for-developers.rst | 15 +++++ doc/index-indices.rst | 10 ++++ doc/index-install.rst | 13 ++++ doc/index-other-material.rst | 9 +++ doc/index-publishing.rst | 12 ++++ doc/index.rst | 113 ++++------------------------------- 11 files changed, 119 insertions(+), 103 deletions(-) create mode 100644 doc/index-admin.rst create mode 100644 doc/index-api.rst create mode 100644 doc/index-customizing.rst create mode 100644 doc/index-for-developers.rst create mode 100644 doc/index-indices.rst create mode 100644 doc/index-install.rst create mode 100644 doc/index-other-material.rst create mode 100644 doc/index-publishing.rst diff --git a/doc/_templates/footer.html b/doc/_templates/footer.html index addc6974357..50ce0fa2283 100644 --- a/doc/_templates/footer.html +++ b/doc/_templates/footer.html @@ -9,7 +9,7 @@

Source — -Issues +IssuesMailing List — diff --git a/doc/conf.py b/doc/conf.py index dc2a7a8bcc5..638e26ae04c 100644 --- 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'''© 2009-2012, Open Knowledge Foundation. Licensed under `_ software. +This documentation covers how to set up and manage `CKAN `_ 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. @@ -14,106 +14,17 @@ This Administration Guide covers how to set up and manage `CKAN `_. -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` \ No newline at end of file