Basic implementation of automatic documentation using Sphinx

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
+
+%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/source/conf.py

@@ -0,0 +1,36 @@
+# 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('../..')) # libufps dir
+
+project = 'libufps'
+copyright = '2024, Innovation Science'
+author = 'Innovation Science'
+release = '0.1.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+	'sphinx.ext.autodoc',
+	'sphinx.ext.autosummary',
+]
+autosummary_generate = True
+
+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/index.rst

@@ -0,0 +1,30 @@
+libufps
+=======
+
+**ufpsutil**
+
+Unix File Permission Supplicant Utility - A simple utility that indexes directories and records their Unix permission and ownership data.
+
+**Purpose**
+
+The purpose of this project is to recursively delve into subdirectories and record their Unix file permissions and ownership information.
+
+Most offsite backup solutions (such as Backblaze) don't store file permissions or ownership information. This means that in the event that data needs to be restored from them, time will need to be taken in order to update permissions and owners, which adds additional downtime.
+
+Naturally, enterprises have solutions to this, but self hosters may not. This project aims to remedy that.
+
+The idea is to record all of this information to a text file, which is backed up off-site as a normal file. This file can then be read by the utility to restore permissions, thereby making the restored backup as close as possible to how it was before it crashed. If mounted to the same locations, this solves any permissions issues a self hoster could face getting back up and running after a catastrophe.
+
+**libufps**
+
+libufps is a modulized version of ufpsutil. Most of ufpsutil's code resides in libufps.
+
+**Status**
+	- ❎ Recurse a directory (index)
+	- ❎ Store Unix file permissions and ownership data
+	- ❎ Restore Unix file permissions and ownership data using index file as an input
+	- ❎ Diff index file and restored backup and inform the user of file inconsistencies
+
+.. toctree::
+	libufps
+	ufpsutil

docs/source/libufps.rst

@@ -0,0 +1,8 @@
+libufps
+=======
+
+.. autosummary::
+	:toctree: _autosummary
+	:recursive:
+
+	libufps.ufps.ufps

docs/source/ufpsutil.rst

@@ -0,0 +1,11 @@
+ufpsutil
+========
+
+Driver for libufps
+
+..
+	.. autosummary::
+		:toctree: _autosummary
+		:recursive:
+
+		libufps.ufps.ufps