From 92551557cbd0afbf503e9441343e5816be52df01 Mon Sep 17 00:00:00 2001 From: anhefti Date: Tue, 3 Dec 2019 09:53:48 +0100 Subject: [PATCH] add user docu skeleton --- docs/Makefile | 19 ++++ docs/about.rst | 4 + docs/conf.py | 193 +++++++++++++++++++++++++++++++++++++++ docs/configurations.rst | 13 +++ docs/exams.rst | 24 +++++ docs/index.rst | 21 +++++ docs/institution.rst | 4 + docs/lmssetup.rst | 4 + docs/monitoring.rst | 5 + docs/overview.rst | 15 +++ docs/troubleshooting.rst | 4 + docs/useraccount.rst | 4 + 12 files changed, 310 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/about.rst create mode 100644 docs/conf.py create mode 100644 docs/configurations.rst create mode 100644 docs/exams.rst create mode 100644 docs/index.rst create mode 100644 docs/institution.rst create mode 100644 docs/lmssetup.rst create mode 100644 docs/monitoring.rst create mode 100644 docs/overview.rst create mode 100644 docs/troubleshooting.rst create mode 100644 docs/useraccount.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..69fe55ec --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/about.rst b/docs/about.rst new file mode 100644 index 00000000..5e178b01 --- /dev/null +++ b/docs/about.rst @@ -0,0 +1,4 @@ +About +===== + +.. include:: ../README.rst \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..30b0235e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,193 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = u'SEB Server Setup' +copyright = u'2019, ETH Zurich' +author = u'Andreas Hefti' + +# The short X.Y version +version = u'0.5' +# The full version, including alpha/beta/rc tags +release = u'' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.doctest', + 'sphinx.ext.todo', + 'sphinx.ext.imgmath', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# 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 +# documentation. +# +html_theme_options = { + "description": "Documentation for SEB Server installation", + "github_user": "anhefti", + "github_repo": "seb-server-setup", + "link": "#3782BE", + "link_hover": "#3782BE", + "page_width": "1024px", +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'SEBServerSetupdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'SEBServerSetup.tex', u'SEB Server Setup Documentation', + u'Andreas Hefti', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'sebserversetup', u'SEB Server Setup Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'SEBServerSetup', u'SEB Server Setup Documentation', + author, 'SEBServerSetup', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/docs/configurations.rst b/docs/configurations.rst new file mode 100644 index 00000000..d8a0db42 --- /dev/null +++ b/docs/configurations.rst @@ -0,0 +1,13 @@ +SEB Configurations +================== + +TODO + +Client Configuration +==================== + +TODO + +Exam Configuration +================== + diff --git a/docs/exams.rst b/docs/exams.rst new file mode 100644 index 00000000..6a442dbb --- /dev/null +++ b/docs/exams.rst @@ -0,0 +1,24 @@ +Exams +===== + +TODO + +Import +------ + +TODO + +Exam Configuration Binding +-------------------------- + +TODO + +Thresholds +---------- + +TODO + +Automatic SEB Restriction +------------------------- + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..c53a0ebd --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +.. SEB Server Setup documentation master file, created by + sphinx-quickstart on Mon Dec 2 10:10:05 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +SEB Server User Guide +===================== + +.. toctree:: + :maxdepth: 3 + + about + overview + institution + useraccount + lmssetup + configurations + exams + monitoring + troubleshooting + diff --git a/docs/institution.rst b/docs/institution.rst new file mode 100644 index 00000000..804658fd --- /dev/null +++ b/docs/institution.rst @@ -0,0 +1,4 @@ +Institution +=========== + +TODO \ No newline at end of file diff --git a/docs/lmssetup.rst b/docs/lmssetup.rst new file mode 100644 index 00000000..ca470238 --- /dev/null +++ b/docs/lmssetup.rst @@ -0,0 +1,4 @@ +Leraning Management System (LMS) Binding +======================================== + +TODO \ No newline at end of file diff --git a/docs/monitoring.rst b/docs/monitoring.rst new file mode 100644 index 00000000..82ecd985 --- /dev/null +++ b/docs/monitoring.rst @@ -0,0 +1,5 @@ +Exam Monitoring +=============== + +TODO + diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 00000000..8c303149 --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,15 @@ +Overview +======== + +TODO + +Roles +----- + +TODO + + +Use Cases +--------- + +TODO \ No newline at end of file diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst new file mode 100644 index 00000000..1985d1e7 --- /dev/null +++ b/docs/troubleshooting.rst @@ -0,0 +1,4 @@ +Troubleshooting +=============== + +TODO diff --git a/docs/useraccount.rst b/docs/useraccount.rst new file mode 100644 index 00000000..02057ba0 --- /dev/null +++ b/docs/useraccount.rst @@ -0,0 +1,4 @@ +User Accounts +============= + +TODO \ No newline at end of file