Skip to content

Commit

Permalink
[#2898] Fix documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
smotornyuk committed Mar 15, 2016
1 parent b1fb19e commit 5c42dc9
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 21 deletions.
11 changes: 7 additions & 4 deletions ckan/lib/helpers.py
Expand Up @@ -1674,10 +1674,13 @@ def get_request_param(parameter_name, default=None):
def html_auto_link(data):
'''Linkifies HTML
tag:... converted to a tag link
dataset:... converted to a dataset link
group:... converted to a group link
http://... converted to a link
`tag` converted to a tag link
`dataset` converted to a dataset link
`group` converted to a group link
`http://` converted to a link
'''

LINK_FNS = {
Expand Down
2 changes: 1 addition & 1 deletion ckan/plugins/interfaces.py
Expand Up @@ -89,7 +89,7 @@ def after_map(self, map):
class IMapper(Interface):
"""
A subset of the SQLAlchemy mapper extension hooks.
See http://www.sqlalchemy.org/docs/05/reference/orm/interfaces.html#sqlalchemy.orm.interfaces.MapperExtension
See http://docs.sqlalchemy.org/en/rel_0_9/orm/deprecated.html#sqlalchemy.orm.interfaces.MapperExtension
Example::
Expand Down
2 changes: 1 addition & 1 deletion ckanext/datastore/logic/action.py
Expand Up @@ -453,7 +453,7 @@ def datastore_search_sql(context, data_dict):
The datastore_search_sql action allows a user to search data in a resource
or connect multiple resources with join expressions. The underlying SQL
engine is the
`PostgreSQL engine <http://www.postgresql.org/docs/9.1/interactive/sql/.html>`_.
`PostgreSQL engine <http://www.postgresql.org/docs/9.1/interactive/>`_.
There is an enforced timeout on SQL queries to avoid an unintended DOS.
DataStore resource that belong to a private CKAN resource cannot be searched with
this action. Use :meth:`~ckanext.datastore.logic.action.datastore_search` instead.
Expand Down
2 changes: 1 addition & 1 deletion doc/contributing/css.rst
Expand Up @@ -4,7 +4,7 @@ CSS coding standards

.. Note::
For CKAN 2.0 we use LESS as a pre-processor for our core CSS. View
`Front-end Documentation <./frontend-development.html#stylesheets>`_
`Front-end Documentation <./frontend/index.html#stylesheets>`_
for more information on this subject.

----------
Expand Down
2 changes: 1 addition & 1 deletion doc/contributing/documentation.rst
Expand Up @@ -644,7 +644,7 @@ Wrong:
* Libraries Available To Extensions

For lots of examples of this done right, see
`Django's table of contents <https://docs.djangoproject.com/en/1.5/contents/>`_.
`Django's table of contents <https://docs.djangoproject.com/en/1.9/contents/>`_.

In Sphinx, use the following section title styles::

Expand Down
8 changes: 4 additions & 4 deletions doc/contributing/javascript.rst
Expand Up @@ -244,7 +244,7 @@ The formatting is as follows::
* client.getTemplate('index.html', {limit: 1}, function (html) {
* module.el.html(html);
* });
*
*
* Returns describes what the object returns.
*/

Expand All @@ -268,7 +268,7 @@ For example::
* client.getTemplate('index.html', {limit: 1}, function (html) {
* module.el.html(html);
* });
*
*
* Returns a jqXHR promise object that can be used to attach callbacks.
*/

Expand All @@ -282,7 +282,7 @@ For unit testing we use the following libraries.
- `Sinon`_: Provides spies, stubs and mocks for methods and functions.
- `Chai`_: Provides common assertions.

.. _Mocha: http://visionmedia.github.com/mocha/
.. _Mocha: https://mochajs.org/
.. _Sinon: http://chaijs.com/
.. _Chai: http://sinonjs.org/docs/

Expand Down Expand Up @@ -317,7 +317,7 @@ Ajax
Calls to the CKAN API from JavaScript should be done through the
`CKAN client`_.

.. _CKAN client: ./frontend-development.html#client
.. _CKAN client: ./frontend/index.html#client

Ajax requests can be used to improve the experience of submitting forms and
other actions that require server interactions. Nearly all requests will
Expand Down
2 changes: 1 addition & 1 deletion doc/contributing/pull-requests.rst
Expand Up @@ -64,7 +64,7 @@ This section will walk you through the steps for making a pull request.

- Your branch should contain new or changed tests for any new or changed
code, and all the CKAN tests should pass on your branch, see
`Testing CKAN <http://docs.ckan.org/en/latest/test.html>`_.
:doc:`test`.

- Your pull request shouldn't lower our test coverage. You can check it at
our `coveralls page <https://coveralls.io/r/ckan/ckan>`. If for some
Expand Down
4 changes: 2 additions & 2 deletions doc/contributing/python.rst
Expand Up @@ -8,7 +8,7 @@ For Python code style follow `PEP 8`_ plus the guidelines below.

Some good links about Python code style:

- `Python Coding Standards <http://lists.osafoundation.org/pipermail/dev/2003-March/000479.html>`_ from Yahoo
- `Guide to Python <http://docs.python-guide.org/en/latest/writing/style/>`_ from Hitchhiker's
- `Google Python Style Guide <http://google-styleguide.googlecode.com/svn/trunk/pyguide.html>`_

.. seealso::
Expand Down Expand Up @@ -316,7 +316,7 @@ Indicate optional arguments by ending their descriptions with ``(optional)`` in
brackets. Where relevant also indicate the default value: ``(optional, default:
5)``.

.. _Sphinx field lists: http://sphinx.pocoo.org/markup/desc.html#info-field-lists
.. _Sphinx field lists: http://www.sphinx-doc.org/en/stable/markup/misc.html

You can also use a little inline `reStructuredText markup`_ in docstrings, e.g.
``*stars for emphasis*`` or ````double-backticks for literal text````
Expand Down
4 changes: 3 additions & 1 deletion doc/extensions/remote-config-update.rst
Expand Up @@ -4,7 +4,9 @@ Making configuration options runtime-editable

Extensions can allow certain configuration options to be edited during
:ref:`runtime <runtime-config>`, as opposed to having to edit the
`configuration file <CKAN configuration file>`_ and restart the server.
`configuration file`_ and restart the server.

.. _configuration file: ../maintaining/configuration.html#ckan-configuration-file

.. warning::

Expand Down
2 changes: 1 addition & 1 deletion doc/extensions/translating-extensions.rst
Expand Up @@ -96,7 +96,7 @@ Manually create translations
We will create translation files for the ``fr`` locale. Create the translation
PO files for the locale that you are translating for by running `init_catalog
<http://babel.pocoo.org/docs/setup/#init-catalog>`_::
<http://babel.pocoo.org/en/latest/setup.html#init-catalog>`_::
python setup.py init_catalog -l fr
Expand Down
2 changes: 1 addition & 1 deletion doc/maintaining/datastore.rst
Expand Up @@ -276,7 +276,7 @@ Download resource as CSV

A DataStore resource can be downloaded in the `CSV`_ file format from ``{CKAN-URL}/datastore/dump/{RESOURCE-ID}``.

.. _CSV: //en.wikipedia.org/wiki/Comma-separated_values
.. _CSV: https://en.wikipedia.org/wiki/Comma-separated_values


.. _fields:
Expand Down
2 changes: 1 addition & 1 deletion doc/theming/javascript.rst
Expand Up @@ -460,7 +460,7 @@ with the following contents:

If this JavaScript code looks a little confusing at first, it's probably
because it's using the
`Immediately-Invoked Function Expression (IIFE) <http://stage.learn.jquery.com/javascript-101/functions/#immediately-invoked-function-expression-iife>`_
`Immediately-Invoked Function Expression (IIFE) <https://en.wikipedia.org/wiki/Immediately-invoked_function_expression>`_
pattern. This is a common JavaScript code pattern in which an anonymous
function is created and then immediately called once, in a single expression.
In the example above, we create an unnamed function that takes a single
Expand Down
4 changes: 2 additions & 2 deletions doc/theming/templates.rst
Expand Up @@ -293,7 +293,7 @@ config file you would put this code in any template file:
CKAN's :ref:`template helper functions <template helper functions>` and any
:ref:`custom template helper functions <custom template helper functions>`
provided by your extension,
and use any of the
and use any of the
`literals and operators <http://jinja.pocoo.org/docs/templates/#expressions>`_
that Jinja provides.

Expand Down Expand Up @@ -680,7 +680,7 @@ use the right HTML tags and CSS classes.

There are two places to look for CSS classes available in CKAN:

1. The `Bootstrap 2.3.2 docs <bootstrap>`_. All of the HTML, CSS and JavaScript
1. The `Bootstrap 2.3.2 docs <http://getbootstrap.com/2.3.2/components.html>`_. All of the HTML, CSS and JavaScript
provided by Bootstrap is available to use in CKAN.

2. CKAN's development primer page, which can be found on any CKAN site at
Expand Down

0 comments on commit 5c42dc9

Please sign in to comment.