From 2b47d33684b127e89e99b5ebfbb031aaffd17a65 Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Mon, 7 Nov 2022 08:58:43 +0100
Subject: [PATCH] default sphinx quickstart

---
 docs/Makefile         | 20 ++++++++++++++++++++
 docs/source/conf.py   | 27 +++++++++++++++++++++++++++
 docs/source/index.rst | 20 ++++++++++++++++++++
 requirements.txt      |  4 +++-
 4 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 docs/Makefile
 create mode 100644 docs/source/conf.py
 create mode 100644 docs/source/index.rst

diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..d0c3cbf
--- /dev/null
+++ b/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)
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..e4252cb
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,27 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'NAT Resource Management'
+copyright = '2022, GN5'
+author = 'GN5'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..6f1389e
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,20 @@
+.. NAT Resource Management documentation master file, created by
+   sphinx-quickstart on Mon Nov  7 08:55:05 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to NAT Resource Management's documentation!
+===================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/requirements.txt b/requirements.txt
index 13ca1d7..bb3d43b 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,4 +5,6 @@ alembic
 mysqlclient
 click
 
-pytest
\ No newline at end of file
+pytest
+sphinx
+sphinx-rtd-theme
-- 
GitLab