Skip to content

Commit

Permalink
Merge pull request #2517 from ckan/2517-rtd-toc-redirects
Browse files Browse the repository at this point in the history
show toc on front of docs, use rtd redirects
  • Loading branch information
joetsoi committed Sep 9, 2015
2 parents 35ca145 + 27fb79b commit 6a1826f
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 39 deletions.
7 changes: 0 additions & 7 deletions doc/api.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Full table of contents

.. toctree::

index
user-guide
sysadmin-guide
maintaining/index
Expand Down
5 changes: 3 additions & 2 deletions doc/contributing/reviewing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ with it. Nonetheless, here is an incomplete list of things to look for:
plugins and themes.

In general, any code that's documented in the reference sections of the
:doc:`API </api>`, :doc:`extensions </extensions/index>` or :doc:`theming
</theming/index>` needs to be considered. For example this includes changes
:doc:`API </api/index>`, :doc:`extensions </extensions/index>` or
:doc:`theming </theming/index>`
needs to be considered. For example this includes changes
to the API actions, the plugin interfaces or plugins toolkit, the converter
and validator functions (which are used by plugins), the custom Jinja2 tags
and variables available to Jinja templates, the template helper functions,
Expand Down
45 changes: 16 additions & 29 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,42 +1,29 @@
:orphan: true

========
Overview
========

Welcome to CKAN's documentation! These docs are organized into several guides,
each guide serves a different audience of CKAN users or contributors:

:doc:`user-guide`
The guide for people who will be using a CKAN site through its web interface,
explains how to use the web interface and its features.

:doc:`sysadmin-guide`
The guide for people with a sysadmin account on a CKAN site,
explains how to use the sysadmin features of the CKAN web interface.

:doc:`/maintaining/index`
The guide for people who will be maintaining a CKAN site, explains how to
install, upgrade and configure CKAN and its features and extensions.

:doc:`/api/index`
The guide for API developers, explains how to write code that interacts with
CKAN sites and their data.
Welcome to CKAN's documentation! These docs are organized into several guides,
each guide serves a different audience of CKAN users or contributors.

:doc:`/extensions/index`
The guide for extension developers, explains how to customize and extend
CKAN's features.
.. toctree::
:maxdepth: 2

:doc:`/theming/index`
The guide for theme developers, explains how to customize the appearance and
content of CKAN's web interface.
user-guide
sysadmin-guide
maintaining/index
api/index
extensions/index
theming/index
contributing/index
changelog

:doc:`/contributing/index`
The guide for people who want to contribute to CKAN itself,
explains how to make all kinds of contributions to CKAN,
including reporting bugs, testing and QA, translating CKAN, helping with
CKAN's documentation, and contributing to the CKAN code.
.. seealso::

Finally, the :doc:`/changelog` documents the differences between CKAN releases,
useful information for anyone who is using CKAN.
:doc:`contents`

.. note::

Expand Down

0 comments on commit 6a1826f

Please sign in to comment.