diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..8b29cc76e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,55 @@ +# 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: +# 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 = 'upp_docs' +copyright = '2019, Tracy Hertneky' +author = 'Tracy Hertneky' + +# The full version, including alpha/beta/rc tags +release = 'v1' + + +# -- 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 = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# 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 = 'alabaster' + +# 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'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..c347c3843 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. upp_docs documentation master file, created by + sphinx-quickstart on Wed Nov 13 10:17:56 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to upp_docs's documentation! +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + UPP_Users_guide_V4_ufs + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`