ckanext-cob_theme |
Based on City of Boston Brand Guidelines
https://www.boston.gov/departments/innovation-and-technology/brand-guidelines
Compatible with CKAN 2.3+
Install the ckanext-showcase extension
------------Development Installation ------------
To install ckanext-cob_theme:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Download the ckanext-cob_theme github repository:
cd /usr/lib/ckan/default/src git clone https://github.com/Ontodia/ckanext-cob_theme.git
Install the extension into your virtual environment:
cd ckanext-cob_theme python setup.py develop
- Add
cob_theme
to theckan.plugins
setting in your CKAN config file (by default the config file is located at/etc/ckan/default/production.ini
). Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
sudo service apache2 reload
Document any optional config settings here. For example:
# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.cob_theme.some_setting = some_default_value
To install API Documentation:
Install Sphinx and Alabaster theme on your virtual environement:
sudo apt-get install python-sphinx pip install -e git+https://github.com/bitprophet/alabaster/#egg=alabaster
Run the doc generate python script and sphinx build command to create static html files:
cd ckanext-cob_theme/docs/ python generate.py ../../ckan/doc cp conf.py ./doc sphinx-build -b html ./doc ../ckanext/cob_theme/templates/docs/snippets
Use the doc-template file to add the header and footer to all the static html files:
cd ../ckanext/cob_theme/templates/docs/snippets mkdir -p __static/docs mv _static __static/docs mv __static _static