diff --git a/SciPost_v1/settings/base.py b/SciPost_v1/settings/base.py index 0215e50cc602ae2bb6ef0fbcef0beb6ca26bc92b..26938f784a87c2a4e529aff70628aa67e7544a51 100644 --- a/SciPost_v1/settings/base.py +++ b/SciPost_v1/settings/base.py @@ -126,6 +126,8 @@ HAYSTACK_SIGNAL_PROCESSOR = 'SciPost_v1.signalprocessors.AutoSearchIndexingProce SPHINXDOC_BASE_TEMPLATE = 'scipost/base.html' SPHINXDOC_PROTECTED_PROJECTS = { 'admin': ['scipost.can_view_docs_scipost'], + 'codebase': ['scipost.can_view_docs_scipost'], + 'users': ['scipost.can_view_docs_scipost'], } CAPTCHA_CHALLENGE_FUNCT = 'captcha.helpers.math_challenge' diff --git a/docs/codebase/maintenance/docs.rst b/docs/codebase/maintenance/docs.rst index 5c6bf8b65bdac421721a52cf7766d3b79df018df..3235a64ff568d3c4d8345cdfa85711d954828af2 100644 --- a/docs/codebase/maintenance/docs.rst +++ b/docs/codebase/maintenance/docs.rst @@ -2,6 +2,7 @@ Maintenance of SciPost documentation ==================================== + Sphinx-generated docs --------------------- @@ -16,6 +17,17 @@ In the `docs` subfolders `codebase`, `admin` and `users`, invoke ``make html``. Sphinxdoc-generated docs (viewable online) ------------------------------------------ + +Setting things up +~~~~~~~~~~~~~~~~~ + +The `django-sphinxdoc` app creates `Project` and `Document` classes. In the admin, one should create the following projects (slug in parentheses): + + * SciPost Admin (admin) + * SciPost Codebase (codebase) + * SciPost Users (users) + + Updating the docs: ~~~~~~~~~~~~~~~~~~