adding sphinx documentation

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+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)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_static/custom.css

@@ -0,0 +1,87 @@
+@import url("css/theme.css");
+
+.modname {
+    font-size: 0.8em;
+    opacity: 0.4;
+}
+.modname::before {
+    content: '- ';
+}
+.title {
+    font-weight: bold;
+    font-size: 1.2em;
+    background-color: #eee;
+    display: block;
+    padding: 1px 5px;
+    border-left: 2px solid #ddd;
+}
+
+/*colour of the text in the toc*/
+.wy-menu-vertical header, .wy-menu-vertical p.caption{
+    color: #b26d46;;
+}
+
+/*colour of the top left header*/
+.wy-side-nav-search{
+    background-color: #31465a;
+}
+
+/*colours of the class definitions*/
+.rst-content dl:not(.docutils) dt{
+    background: #e2d7d1;
+    color: #0b2852;
+    border-top: solid 3px #31465a;
+}
+
+/*colour of the link in the class defintions*/
+.rst-content .viewcode-link, .rst-content .viewcode-back{
+    color: #4b674a;
+}
+
+/*colour of the function definitions*/
+.rst-content dl:not(.docutils) dl dt{
+    border-left: solid 3px #31465a;
+    background: #e2d7d1;
+    color: #0b2852;
+}
+
+/*colour of the link in the function definitions*/
+.rst-content .viewcode-link, .rst-content .viewcode-back{
+    color: #4b674a;
+}
+
+/*edit the width of the body*/
+.wy-nav-content{
+    max-width: 1200px;
+}
+
+/*code example blocks*/
+.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre{
+    background: #b4bec8;
+    color: black;
+    /*border-style: solid;*/
+    /*border-width: thin;*/
+}
+
+/*colour of inline code blocks using ``*/
+.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal{
+    color: #b26d46;
+}
+
+/* Change code blocks font and bump up font size slightly (normally 12px)*/
+.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre {
+    font-family: 'Inconsolata', monospace !important;
+    font-size: 14px !important;
+    white-space: pre-wrap;
+}
+
+/* Change code descriptions and literal blocks (inline code via ``) to match the normal font size being used in the sphinx_RTD_theme text  (normally 14px)*/
+.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname, code.docutils {
+    font-family: 'Inconsolata', monospace !important;
+    font-size: 14px !important;
+}
+
+/*variables text*/
+dl.class > dd > table.docutils.field-list tbody tr.field-odd.field th.field-name::before{
+    content: '(Class Attributes) ';
+}

docs/source/changelog.rst

@@ -0,0 +1,7 @@
+Version history
+================
+
+1.0
+--------
+
+- initial release

docs/source/conf.py

@@ -0,0 +1,95 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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('.'))
+import panaetius
+from panaetius.__version__ import __version__ as version
+import sphinx_rtd_theme
+
+# -- Project information -----------------------------------------------------
+
+project = 'panaetius'
+copyright = '2019, Daniel Tomlinson'
+author = 'Daniel Tomlinson'
+
+# The full version, including alpha/beta/rc tags
+release = version
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
+]
+
+# -- Napoleon Settings -----------------------------------------------------
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = False
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = True
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_use_keyword = True
+autodoc_member_order = 'bysource'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The master toctree document.
+master_doc = 'index'
+
+# 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 = []
+
+
+# -- 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"
+
+# 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_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_static_path = ['_static']
+html_context = {'css_files': ['_static/custom.css']}
+html_theme_options = {
+    'collapse_navigation': True,
+    'display_version': True,
+    'prev_next_buttons_location': 'both',
+    #'navigation_depth': 3,
+}
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# Enable todo
+todo_include_todos = True

docs/source/configuration.rst

@@ -0,0 +1,4 @@
+Configuration
+=============
+
+.. todo:: fill in configuration options

docs/source/global.rst

@@ -0,0 +1,5 @@
+.. role:: modname
+   :class: modname
+
+.. role:: title
+   :class: title

docs/source/index.rst

@@ -0,0 +1,3 @@
+Table of Contents
+=================
+.. include:: toc.rst

docs/source/introduction.rst

@@ -0,0 +1,4 @@
+panaetius
+==========
+
+tbc

docs/source/modules/modules.rst

@@ -0,0 +1,7 @@
+panaetius
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   panaetius

docs/source/modules/panaetius.config.rst

@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.config`
+-------------------------------------
+
+.. automodule:: panaetius.config
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/panaetius.config_inst.rst

@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.config_inst`
+---------------------------------------
+
+.. automodule:: panaetius.config_inst
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/panaetius.db.rst

@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.db`
+-------------------------------------
+
+.. automodule:: panaetius.db
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/panaetius.header.rst

@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.header`
+-------------------------------------
+
+.. automodule:: panaetius.header
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/panaetius.library.rst

@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.library`
+-------------------------------------
+
+.. automodule:: panaetius.library
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/panaetius.logging.rst

@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.logging`
+-------------------------------------
+
+.. automodule:: panaetius.logging
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/panaetius.rst

@@ -0,0 +1,21 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius`
+-------------------------------------
+
+.. automodule:: panaetius
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   panaetius.config
+   panaetius.config_inst
+   panaetius.db
+   panaetius.header
+   panaetius.library
+   panaetius.logging

docs/source/toc.rst

@@ -0,0 +1,28 @@
+.. toctree::
+   :maxdepth: 1
+   :caption: Overview
+   :titlesonly:
+
+   introduction
+   configuration
+   changelog
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Modules
+   :titlesonly:
+
+   modules/panaetius.rst
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Submodules
+   :titlesonly:
+
+   modules/panaetius.config.rst
+   modules/panaetius.config_inst.rst
+   modules/panaetius.db.rst
+   modules/panaetius.header.rst
+   modules/panaetius.library.rst
+   modules/panaetius.logging.rst
+   modules/panaetius.rst