Added sphinx documentation generation and requirements.txt (required by sphinx)

Author: Rasmus Oscar Welander

docs/.DS_Store

@@ -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/Makefile

@@ -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
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/make.bat

@@ -0,0 +1,7 @@
+app Module
+==========
+
+.. automodule:: app
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/app.rst

@@ -0,0 +1,7 @@
+auth Module
+===========
+
+.. automodule:: auth
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/auth.rst

@@ -0,0 +1,7 @@
+checkpoint Module
+=================
+
+.. automodule:: checkpoint
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/checkpoint.rst

@@ -0,0 +1,37 @@
+# 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
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("/Users/account/Documents/project/code_from_git/python-cs3apis"))
+sys.path.insert(0, os.path.abspath("/Users/account/Documents/project/code_from_git/cs3-python-client/src/"))
+
+project = "cs3client"
+copyright = "2024, Rasmus Welander, Diogo Castro, Giuseppe Lo Presti"
+author = "Rasmus Welander, Diogo Castro, Giuseppe Lo Presti"
+release = "0.0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",  # Optional for Google/NumPy-style docstrings
+    "sphinx.ext.viewcode",  # Optional to add links to source code
+]
+
+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"]

docs/source/conf.py

@@ -0,0 +1,7 @@
+cs3client Module
+================
+
+.. automodule:: cs3client
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cs3client.rst

@@ -0,0 +1,7 @@
+cs3resource Module
+==================
+
+.. automodule:: cs3resource
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cs3resource.rst

@@ -0,0 +1,7 @@
+exceptions Module
+=================
+
+.. automodule:: exceptions.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance: