SciPost Code Repository

Skip to content
Snippets Groups Projects
Commit a9b3cb93 authored by Jean-Sébastien Caux's avatar Jean-Sébastien Caux
Browse files

Installation of documentation via sphinx, django-sphinx (sphinxdoc).

Haystack search facility was required and is installed, with Whoosh engine.

Requirements updated.

Instructions for setting things up:
haystack: http://django-haystack.readthedocs.io/en/v2.5.0/ (choice: Whoosh engine)
sphinx: http://www.sphinx-doc.org/en/1.5.1/
sphinxdoc: http://django-sphinxdoc.readthedocs.io/en/latest/

In particular, a Project has to be defined in app sphinxdoc in order for docs to be displayed (starting at /docs/).

New host_settings needed:
HAYSTACK_PATH (for the location of the Whoosh index (suggestion: project's root); make sure this is not readable by site visitors)
parent 2f19b164
No related branches found
No related tags found
No related merge requests found
Showing
with 402 additions and 230 deletions
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment