Skip to content

Commit

Permalink
[#523] sphinx fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
tobes authored and Sean Hammond committed May 3, 2013
1 parent e226598 commit 7da5f42
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 8 deletions.
4 changes: 2 additions & 2 deletions doc/architecture.rst
Expand Up @@ -179,13 +179,13 @@ See :doc:`test` for further information on testing in CKAN.
Writing Extensions
------------------

Please see :doc:`writing-extensions` for information about writing ckan
Please see :ref:`writing-extensions` for information about writing ckan
extensions, including details on the API available to extensions.

Deprecation
-----------

- Anything that may be used by extensions (see :doc:`writing-extensions`) needs
- Anything that may be used by extensions (see :ref:`writing-extensions`) needs
to maintain backward compatibility at call-site. ie - template helper
functions and functions defined in the plugins toolkit.

Expand Down
2 changes: 1 addition & 1 deletion doc/background-tasks.rst
Expand Up @@ -7,7 +7,7 @@ Background Tasks
CKAN allows you to create tasks that run in the 'background', that is
asynchronously and without blocking the main application (these tasks can also
be automatically retried in the case of transient failures). Such tasks can be
created in :doc:`Extensions <writing-extensions>` or in core CKAN.
created in :ref:`Extensions <writing-extensions>` or in core CKAN.

Background tasks can be essential to providing certain kinds of functionality,
for example:
Expand Down
4 changes: 3 additions & 1 deletion doc/extensions.rst
Expand Up @@ -21,8 +21,8 @@ CKAN comes with several pre-installed extensions:
* ``reclinepreview`` - Preview Google Documents, CSV files, Excel files,
etc. via the Recline.js library
* ``jsonpreview`` - Preview json files
* ``resourceproxy`` - Allow remotly hosted content to be viewed

* ``resourceproxy`` - ????

* ``stats`` - Show stats and visuals about your site's datasets

Expand All @@ -35,6 +35,8 @@ for how to install and configure it. For a list of external extensions, see the
`list of extensions the CKAN wiki <https://github.com/okfn/ckan/wiki/List-of-extensions>`_.


.. _writing-extensions:

==================
Writing Extensions
==================
Expand Down
3 changes: 0 additions & 3 deletions doc/index.rst
Expand Up @@ -40,16 +40,13 @@ Customizing and Extending
resources
apps-ideas
extensions
writing-extensions
toolkit
tag-vocabularies
form-integration
linked-data-and-rdf
filestore
datastore
background-tasks
harvesting
geospatial
multilingual
email-notifications
tracking
Expand Down
2 changes: 1 addition & 1 deletion doc/tag-vocabularies.rst
Expand Up @@ -61,7 +61,7 @@ To add a tag vocabulary to a site, a CKAN sysadmin must:
vocabulary and tags. See :doc:`api`.

2. Implement an ``IDatasetForm`` plugin to add a new field for the tag
vocabulary to the dataset schema. See :doc:`writing-extensions`.
vocabulary to the dataset schema. See :ref:`writing-extensions`.

3. Provide custom dataset templates to display the new field to users when
adding, updating or viewing datasets in the CKAN web interface.
Expand Down

0 comments on commit 7da5f42

Please sign in to comment.