Skip to content

Commit

Permalink
[release-v1.6][doc]: Fix warnings and errors in sphinx docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
David Read committed Feb 24, 2012
1 parent 77e070c commit 6c7da48
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions ckan/plugins/interfaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,8 @@ def before_search(self, search_params):
Extensions will receive a dictionary with the query parameters,
and should return a modified (or not) version of it.
search_params will include an 'extras' dictionary with all values
from fields starting with 'ext_', so extensions can receive user
search_params will include an `extras` dictionary with all values
from fields starting with `ext_`, so extensions can receive user
input from specific fields.
'''
Expand All @@ -254,8 +254,8 @@ def after_search(self, search_results, search_params):
Note that count and facets may need to be adjusted if the extension
changed the results for some reason.
search_params will include an 'extras' dictionary with all values
from fields starting with 'ext_', so extensions can receive user
search_params will include an `extras` dictionary with all values
from fields starting with `ext_`, so extensions can receive user
input from specific fields.
'''
Expand Down
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Contents:
file-upload
configuration
api
apiv3
test
common-error-messages
buildbot
Expand Down
7 changes: 3 additions & 4 deletions doc/install-from-source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ or if your config file is something else, you need to specify it. e.g.::

paster --plugin=ckan db init --config=test.ckan.net.ini

You should see ``Initialising DB: SUCCESS``. (There will also be some ``SAWarning``s which can be ignored and probably also an error/warning about "connecting to the SOLR server", which will be addressed in a couple of steps time.)
You should see ``Initialising DB: SUCCESS``. (There will also be some ``SAWarning`` messages which can be ignored and probably also an error/warning about "connecting to the SOLR server", which will be addressed in a couple of steps time.)

If the command prompts for a password it is likely you haven't set up the
database configuration correctly in step 6.
Expand Down Expand Up @@ -269,12 +269,11 @@ You need to create two directories for CKAN to put temporary files:


12. Test the CKAN webserver
~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can use Paste to serve CKAN from the command-line. This is a simple and lightweight way to serve CKAN and is especially useful for testing. However a production deployment will probably want to be served using Apache or nginx - see :doc:`post-installation`

.. note: If you've started a new shell, you'll have to activate the environment
again first - see step 3.
.. note:: If you've started a new shell, you'll have to activate the environment again first - see step 3.

(from the ``pyenv/src/ckan`` directory):

Expand Down
2 changes: 1 addition & 1 deletion doc/paster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ The pg_dump file notes which PostgreSQL user 'owns' the data on the server. Beca
Upgrade migration
~~~~~~~~~~~~~~~~~

When you upgrade CKAN software by any method *other* than the package update described in :doc:`upgrade`, before you restart it, you should run 'db upgrade', which will do any necessary migrations to the database tables::
When you upgrade CKAN software by any method *other* than the package update described in :doc:`install-from-package`, before you restart it, you should run 'db upgrade', which will do any necessary migrations to the database tables::

paster --plugin=ckan db upgrade --config=/etc/ckan/std/std.ini

Expand Down
2 changes: 1 addition & 1 deletion doc/writing-extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To meet the need to customize CKAN efficiently, we have introduced the concepts
interfaces and workers. These work together to provide a simple mechanism to
extend core CKAN functionality.

.. warning:: This is an advanced topic. At the moment, you need to have prepared your system to work with extensions, as described in :doc:`prepare-extensions`. We are working to make the most popular extensions more easily available as Debian packages.
.. warning:: This is an advanced topic. We are working to make the most popular extensions more easily available as Debian packages.

.. note:: The terms **extension**, **plugin interface** and **worker** have very precise meanings: the use of the generic word **plugin** to describe any way in which CKAN might be extended is deprecated.

Expand Down

0 comments on commit 6c7da48

Please sign in to comment.