From d9c9a1da145f4a3f76cd6c3c8e01004e5cff0bf5 Mon Sep 17 00:00:00 2001
From: "J.-S. Caux" <J.S.Caux@uva.nl>
Date: Fri, 16 Mar 2018 10:08:02 +0100
Subject: [PATCH] Update docs
---
SciPost_v1/settings/base.py | 2 ++
docs/codebase/maintenance/docs.rst | 12 ++++++++++++
2 files changed, 14 insertions(+)
diff --git a/SciPost_v1/settings/base.py b/SciPost_v1/settings/base.py
index 0215e50cc..26938f784 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 5c6bf8b65..3235a64ff 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:
~~~~~~~~~~~~~~~~~~
--
GitLab