From 02c33986965407a35ee026c0eb581460103fe640 Mon Sep 17 00:00:00 2001
From: James Graham <J.Graham@software.ac.uk>
Date: Fri, 9 Nov 2018 16:46:10 +0000
Subject: [PATCH] Add prompts for documentation sections
---
docs/source/conf.py | 3 +-
docs/source/index.rst | 9 +++++
docs/source/user_docs/app_developer.rst | 49 +++++++++++++++++++++++++
docs/source/user_docs/data_provider.rst | 24 ++++++++++++
docs/source/user_docs/index.rst | 10 +++++
docs/source/user_docs/user.rst | 26 +++++++++++++
requirements.txt | 1 +
7 files changed, 121 insertions(+), 1 deletion(-)
create mode 100644 docs/source/user_docs/app_developer.rst
create mode 100644 docs/source/user_docs/data_provider.rst
create mode 100644 docs/source/user_docs/index.rst
create mode 100644 docs/source/user_docs/user.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 7d11932..27f7383 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -83,7 +83,8 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = ['_themes',]
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 54593fd..6f3eaba 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -10,6 +10,15 @@ Welcome to PEDASI's documentation!
:maxdepth: 2
:caption: Contents:
+ user_docs/index
+
+
+Introduction
+============
+
+PEDASI is a...
+
+What sort of research can be done using PEDASI?
Indices and tables
diff --git a/docs/source/user_docs/app_developer.rst b/docs/source/user_docs/app_developer.rst
new file mode 100644
index 0000000..0c3593e
--- /dev/null
+++ b/docs/source/user_docs/app_developer.rst
@@ -0,0 +1,49 @@
+Application Developers
+======================
+
+* Who is an app developer?
+* What can you do with an app?
+* Example application for reference
+
+
+Request Application Developer Access
+------------------------------------
+
+How do I get permission to add apps?
+
+
+Applications (part 2)
+---------------------
+
+See :ref:`applications` first...
+
+
+The Application API
+-------------------
+
+Things that can be Requested
+............................
+
+* List of all data sources
+* Metadata held by PEDASI
+* PROV records held by PEDASI
+* List of datasets via a data source's external API (if it's a catalogue)
+* Metadata via a data source's external API (of data source or dataset)
+* Data via a data source's external API (or data source or dataset)
+
+API Keys
+........
+
+* Normal: get a single API key for your application
+* Sensitive / Private Data: provide a mechanism for your app to pass through the API keys of your users
+
+Data Format
+...........
+
+PEDASI doesn't touch the data format - you get whatever format the data source API provides
+
+
+Hosting your Application
+------------------------
+
+Must have fixed URL we can link to from PEDASI
diff --git a/docs/source/user_docs/data_provider.rst b/docs/source/user_docs/data_provider.rst
new file mode 100644
index 0000000..5b2b0f5
--- /dev/null
+++ b/docs/source/user_docs/data_provider.rst
@@ -0,0 +1,24 @@
+Data Providers
+==============
+
+* Who is a data provider?
+* Why should I let PEDASI use my data?
+* What will app developers do with my data?
+
+
+Request Data Provider Access
+----------------------------
+
+How do I get permission to add data sources?
+
+
+Data Sources (part 2)
+---------------------
+
+See :ref:`data_sources` first...
+
+Permissions
+...........
+
+* What permission levels exist for users?
+* How do I manage them?
diff --git a/docs/source/user_docs/index.rst b/docs/source/user_docs/index.rst
new file mode 100644
index 0000000..035f71a
--- /dev/null
+++ b/docs/source/user_docs/index.rst
@@ -0,0 +1,10 @@
+PEDASI User Documentation
+=========================
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Contents:
+
+ user
+ app_developer
+ data_provider
diff --git a/docs/source/user_docs/user.rst b/docs/source/user_docs/user.rst
new file mode 100644
index 0000000..4f0584f
--- /dev/null
+++ b/docs/source/user_docs/user.rst
@@ -0,0 +1,26 @@
+Using PEDASI
+============
+
+Getting an Account
+------------------
+
+* Why do I need an account?
+* What will be tracked?
+
+
+.. _applications:
+
+Applications
+------------
+
+* What is an application (app)?
+* How do I use one?
+
+
+.. _data_sources:
+
+Data Sources
+------------
+
+* What is a data source?
+* Do I need to worry about these? - usually not
diff --git a/requirements.txt b/requirements.txt
index 900f3ef..0957fc5 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -49,6 +49,7 @@ snowballstemmer==1.2.1
social-auth-app-django==3.0.0
social-auth-core==2.0.0
Sphinx==1.7.6
+sphinx-rtd-theme==0.4.2
sphinxcontrib-websupport==1.1.0
typed-ast==1.1.0
urllib3==1.23
--
GitLab