diff --git a/doc/conf.py b/doc/conf.py index b16d8d0eb64..d3ac70ba380 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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 diff --git a/doc/extensions/tutorial.rst b/doc/extensions/tutorial.rst index 2753d28b535..34685abec90 100644 --- a/doc/extensions/tutorial.rst +++ b/doc/extensions/tutorial.rst @@ -1,3 +1,5 @@ +.. include:: /_substitutions.rst + --------------------------- Writing extensions tutorial --------------------------- @@ -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 ========================