Skip to content

Commit

Permalink
Provide example of requirements installation without source CKAN inst…
Browse files Browse the repository at this point in the history
…allation.

Add note to `Writing extension tutorial` for developers, that are going
to make some contributions to existing extension and don't want to complete
whole installation of CKAN from source, but prefere simple `pip install ckan`
  • Loading branch information
smotornyuk committed Apr 15, 2019
1 parent 330d747 commit d2fb8ab
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/conf.py
Expand Up @@ -39,6 +39,7 @@
.. |production.ini| replace:: |config_dir|/production.ini
.. |development.ini| replace:: |config_dir|/development.ini
.. |git_url| replace:: \https://github.com/ckan/ckan.git
.. |raw_git_url| replace:: \https://raw.githubusercontent.com/ckan/ckan
.. |postgres| replace:: PostgreSQL
.. |database| replace:: ckan_default
.. |database_user| replace:: ckan_default
Expand Down
15 changes: 15 additions & 0 deletions doc/extensions/tutorial.rst
@@ -1,3 +1,5 @@
.. include:: /_substitutions.rst

---------------------------
Writing extensions tutorial
---------------------------
Expand All @@ -18,6 +20,19 @@ install of CKAN on your system. If you don't have a CKAN source install
already, follow the instructions in
:doc:`/maintaining/installing/install-from-source` before continuing.

.. note::

If you are developing extension without actual source installation
of CKAN(i.e. if you have installed CKAN as package via `pip install
ckan`), you can install all main and dev dependencies with the
following commands:

.. parsed-literal::
pip install -r |raw_git_url|/|latest_release_tag|/requirements.txt
pip install -r |raw_git_url|/|latest_release_tag|/dev-requirements.txt
Creating a new extension
========================
Expand Down

0 comments on commit d2fb8ab

Please sign in to comment.