add demo sphinx generator

Makefile

@@ -1,4 +1,4 @@
-.PHONY: architecture archive archive_directory archlinux check clean directory man push tests version
+.PHONY: architecture archive archive_directory archlinux check clean directory docs docs-source man push tests version
 .DEFAULT_GOAL := archlinux
 
 PROJECT := ahriman
@@ -32,14 +32,22 @@ check: clean
 clean:
 	find . -type f -name "$(PROJECT)-*-src.tar.xz" -delete
 	rm -rf "$(PROJECT)"
+	find docs/source -type f -name "$(PROJECT)*.rst" -delete
+	rm -rf docs/html docs/source/modules.rst
 
 directory: clean
 	mkdir "$(PROJECT)"
 
+docs: docs-source
+	sphinx-build -b html -a -j auto docs/source docs/html
+
+docs-source: clean
+	SPHINX_APIDOC_OPTIONS=members,no-undoc-members,show-inheritance sphinx-apidoc --force --private -o docs/source src
+
 man:
 	cd src &&  PYTHONPATH=. argparse-manpage --module ahriman.application.ahriman --function _parser --author "ahriman team" --project-name ahriman --author-email "" --url https://github.com/arcan1s/ahriman --output ../docs/ahriman.1
 
-push: architecture man archlinux
+push: architecture docs-source man archlinux
 	git add package/archlinux/PKGBUILD src/ahriman/version.py docs/ahriman-architecture.svg docs/ahriman.1
 	git commit -m "Release $(VERSION)"
 	git tag "$(VERSION)"

docs/source/ahriman.application.application.rst

@@ -0,0 +1,50 @@
+ahriman.application.application package
+=======================================
+
+Submodules
+----------
+
+ahriman.application.application.application module
+--------------------------------------------------
+
+.. automodule:: ahriman.application.application.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.application.packages module
+-----------------------------------------------
+
+.. automodule:: ahriman.application.application.packages
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.application.properties module
+-------------------------------------------------
+
+.. automodule:: ahriman.application.application.properties
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.application.repository module
+-------------------------------------------------
+
+.. automodule:: ahriman.application.application.repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.application.handlers.rst

@@ -0,0 +1,221 @@
+ahriman.application.handlers package
+====================================
+
+Submodules
+----------
+
+ahriman.application.handlers.add module
+---------------------------------------
+
+.. automodule:: ahriman.application.handlers.add
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.backup module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.backup
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.clean module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.clean
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.dump module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.dump
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.handler module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.help module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.help
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.key\_import module
+-----------------------------------------------
+
+.. automodule:: ahriman.application.handlers.key_import
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.patch module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.patch
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.rebuild module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.rebuild
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.remove module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.remove
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.remove\_unknown module
+---------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.remove_unknown
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.report module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.report
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.restore module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.restore
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.search module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.search
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.setup module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.setup
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.sign module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.sign
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.status module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.status\_update module
+--------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.status_update
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.sync module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.sync
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.unsafe\_commands module
+----------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.unsafe_commands
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.update module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.update
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.user module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.user
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.handlers.web module
+---------------------------------------
+
+.. automodule:: ahriman.application.handlers.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application.handlers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.application.rst

@@ -0,0 +1,41 @@
+ahriman.application package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.application.application
+   ahriman.application.handlers
+
+Submodules
+----------
+
+ahriman.application.ahriman module
+----------------------------------
+
+.. automodule:: ahriman.application.ahriman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.application.lock module
+-------------------------------
+
+.. automodule:: ahriman.application.lock
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.alpm.remote.rst

@@ -0,0 +1,41 @@
+ahriman.core.alpm.remote package
+================================
+
+Submodules
+----------
+
+ahriman.core.alpm.remote.aur module
+-----------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.aur
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.alpm.remote.official module
+----------------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.official
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.alpm.remote.remote module
+--------------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.remote
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.alpm.remote
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.alpm.rst

@@ -0,0 +1,40 @@
+ahriman.core.alpm package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.alpm.remote
+
+Submodules
+----------
+
+ahriman.core.alpm.pacman module
+-------------------------------
+
+.. automodule:: ahriman.core.alpm.pacman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.alpm.repo module
+-----------------------------
+
+.. automodule:: ahriman.core.alpm.repo
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.alpm
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.auth.rst

@@ -0,0 +1,50 @@
+ahriman.core.auth package
+=========================
+
+Submodules
+----------
+
+ahriman.core.auth.auth module
+-----------------------------
+
+.. automodule:: ahriman.core.auth.auth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.auth.helpers module
+--------------------------------
+
+.. automodule:: ahriman.core.auth.helpers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.auth.mapping module
+--------------------------------
+
+.. automodule:: ahriman.core.auth.mapping
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.auth.oauth module
+------------------------------
+
+.. automodule:: ahriman.core.auth.oauth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.auth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.build_tools.rst

@@ -0,0 +1,32 @@
+ahriman.core.build\_tools package
+=================================
+
+Submodules
+----------
+
+ahriman.core.build\_tools.sources module
+----------------------------------------
+
+.. automodule:: ahriman.core.build_tools.sources
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.build\_tools.task module
+-------------------------------------
+
+.. automodule:: ahriman.core.build_tools.task
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.build_tools
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.database.data.rst

@@ -0,0 +1,41 @@
+ahriman.core.database.data package
+==================================
+
+Submodules
+----------
+
+ahriman.core.database.data.package\_statuses module
+---------------------------------------------------
+
+.. automodule:: ahriman.core.database.data.package_statuses
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.database.data.patches module
+-----------------------------------------
+
+.. automodule:: ahriman.core.database.data.patches
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.database.data.users module
+---------------------------------------
+
+.. automodule:: ahriman.core.database.data.users
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database.data
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.database.migrations.rst

@@ -0,0 +1,23 @@
+ahriman.core.database.migrations package
+========================================
+
+Submodules
+----------
+
+ahriman.core.database.migrations.m000\_initial module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m000_initial
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database.migrations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.database.operations.rst

@@ -0,0 +1,59 @@
+ahriman.core.database.operations package
+========================================
+
+Submodules
+----------
+
+ahriman.core.database.operations.auth\_operations module
+--------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.auth_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.database.operations.build\_operations module
+---------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.build_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.database.operations.operations module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.database.operations.package\_operations module
+-----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.package_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.database.operations.patch\_operations module
+---------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.patch_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database.operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.database.rst

@@ -0,0 +1,33 @@
+ahriman.core.database package
+=============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.database.data
+   ahriman.core.database.migrations
+   ahriman.core.database.operations
+
+Submodules
+----------
+
+ahriman.core.database.sqlite module
+-----------------------------------
+
+.. automodule:: ahriman.core.database.sqlite
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.formatters.rst

@@ -0,0 +1,95 @@
+ahriman.core.formatters package
+===============================
+
+Submodules
+----------
+
+ahriman.core.formatters.aur\_printer module
+-------------------------------------------
+
+.. automodule:: ahriman.core.formatters.aur_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.formatters.build\_printer module
+---------------------------------------------
+
+.. automodule:: ahriman.core.formatters.build_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.formatters.configuration\_printer module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.configuration_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.formatters.package\_printer module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.package_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.formatters.printer module
+--------------------------------------
+
+.. automodule:: ahriman.core.formatters.printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.formatters.status\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.status_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.formatters.string\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.string_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.formatters.update\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.update_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.formatters.user\_printer module
+--------------------------------------------
+
+.. automodule:: ahriman.core.formatters.user_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.formatters
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.report.rst

@@ -0,0 +1,68 @@
+ahriman.core.report package
+===========================
+
+Submodules
+----------
+
+ahriman.core.report.console module
+----------------------------------
+
+.. automodule:: ahriman.core.report.console
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.report.email module
+--------------------------------
+
+.. automodule:: ahriman.core.report.email
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.report.html module
+-------------------------------
+
+.. automodule:: ahriman.core.report.html
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.report.jinja\_template module
+------------------------------------------
+
+.. automodule:: ahriman.core.report.jinja_template
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.report.report module
+---------------------------------
+
+.. automodule:: ahriman.core.report.report
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.report.telegram module
+-----------------------------------
+
+.. automodule:: ahriman.core.report.telegram
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.report
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.repository.rst

@@ -0,0 +1,59 @@
+ahriman.core.repository package
+===============================
+
+Submodules
+----------
+
+ahriman.core.repository.cleaner module
+--------------------------------------
+
+.. automodule:: ahriman.core.repository.cleaner
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.repository.executor module
+---------------------------------------
+
+.. automodule:: ahriman.core.repository.executor
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.repository.properties module
+-----------------------------------------
+
+.. automodule:: ahriman.core.repository.properties
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.repository.repository module
+-----------------------------------------
+
+.. automodule:: ahriman.core.repository.repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.repository.update\_handler module
+----------------------------------------------
+
+.. automodule:: ahriman.core.repository.update_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.rst

@@ -0,0 +1,76 @@
+ahriman.core package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.alpm
+   ahriman.core.auth
+   ahriman.core.build_tools
+   ahriman.core.database
+   ahriman.core.formatters
+   ahriman.core.report
+   ahriman.core.repository
+   ahriman.core.sign
+   ahriman.core.status
+   ahriman.core.upload
+
+Submodules
+----------
+
+ahriman.core.configuration module
+---------------------------------
+
+.. automodule:: ahriman.core.configuration
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.exceptions module
+------------------------------
+
+.. automodule:: ahriman.core.exceptions
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.spawn module
+-------------------------
+
+.. automodule:: ahriman.core.spawn
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.tree module
+------------------------
+
+.. automodule:: ahriman.core.tree
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.util module
+------------------------
+
+.. automodule:: ahriman.core.util
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.sign.rst

@@ -0,0 +1,23 @@
+ahriman.core.sign package
+=========================
+
+Submodules
+----------
+
+ahriman.core.sign.gpg module
+----------------------------
+
+.. automodule:: ahriman.core.sign.gpg
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.sign
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.status.rst

@@ -0,0 +1,41 @@
+ahriman.core.status package
+===========================
+
+Submodules
+----------
+
+ahriman.core.status.client module
+---------------------------------
+
+.. automodule:: ahriman.core.status.client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.status.watcher module
+----------------------------------
+
+.. automodule:: ahriman.core.status.watcher
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.status.web\_client module
+--------------------------------------
+
+.. automodule:: ahriman.core.status.web_client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.core.upload.rst

@@ -0,0 +1,59 @@
+ahriman.core.upload package
+===========================
+
+Submodules
+----------
+
+ahriman.core.upload.github module
+---------------------------------
+
+.. automodule:: ahriman.core.upload.github
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.upload.http\_upload module
+---------------------------------------
+
+.. automodule:: ahriman.core.upload.http_upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.upload.rsync module
+--------------------------------
+
+.. automodule:: ahriman.core.upload.rsync
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.upload.s3 module
+-----------------------------
+
+.. automodule:: ahriman.core.upload.s3
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.core.upload.upload module
+---------------------------------
+
+.. automodule:: ahriman.core.upload.upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.models.rst

@@ -0,0 +1,203 @@
+ahriman.models package
+======================
+
+Submodules
+----------
+
+ahriman.models.action module
+----------------------------
+
+.. automodule:: ahriman.models.action
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.aur\_package module
+----------------------------------
+
+.. automodule:: ahriman.models.aur_package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.auth\_settings module
+------------------------------------
+
+.. automodule:: ahriman.models.auth_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.build\_status module
+-----------------------------------
+
+.. automodule:: ahriman.models.build_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.counters module
+------------------------------
+
+.. automodule:: ahriman.models.counters
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.internal\_status module
+--------------------------------------
+
+.. automodule:: ahriman.models.internal_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.migration module
+-------------------------------
+
+.. automodule:: ahriman.models.migration
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.migration\_result module
+---------------------------------------
+
+.. automodule:: ahriman.models.migration_result
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.package module
+-----------------------------
+
+.. automodule:: ahriman.models.package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.package\_description module
+------------------------------------------
+
+.. automodule:: ahriman.models.package_description
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.package\_source module
+-------------------------------------
+
+.. automodule:: ahriman.models.package_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.property module
+------------------------------
+
+.. automodule:: ahriman.models.property
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.report\_settings module
+--------------------------------------
+
+.. automodule:: ahriman.models.report_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.repository\_paths module
+---------------------------------------
+
+.. automodule:: ahriman.models.repository_paths
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.result module
+----------------------------
+
+.. automodule:: ahriman.models.result
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.sign\_settings module
+------------------------------------
+
+.. automodule:: ahriman.models.sign_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.smtp\_ssl\_settings module
+-----------------------------------------
+
+.. automodule:: ahriman.models.smtp_ssl_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.upload\_settings module
+--------------------------------------
+
+.. automodule:: ahriman.models.upload_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.user module
+--------------------------
+
+.. automodule:: ahriman.models.user
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.user\_access module
+----------------------------------
+
+.. automodule:: ahriman.models.user_access
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.models.user\_identity module
+------------------------------------
+
+.. automodule:: ahriman.models.user_identity
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.models
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.rst

@@ -0,0 +1,34 @@
+ahriman package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.application
+   ahriman.core
+   ahriman.models
+   ahriman.web
+
+Submodules
+----------
+
+ahriman.version module
+----------------------
+
+.. automodule:: ahriman.version
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.web.middlewares.rst

@@ -0,0 +1,32 @@
+ahriman.web.middlewares package
+===============================
+
+Submodules
+----------
+
+ahriman.web.middlewares.auth\_handler module
+--------------------------------------------
+
+.. automodule:: ahriman.web.middlewares.auth_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.middlewares.exception\_handler module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.middlewares.exception_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.middlewares
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.web.rst

@@ -0,0 +1,41 @@
+ahriman.web package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.middlewares
+   ahriman.web.views
+
+Submodules
+----------
+
+ahriman.web.routes module
+-------------------------
+
+.. automodule:: ahriman.web.routes
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.web module
+----------------------
+
+.. automodule:: ahriman.web.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.web.views.rst

@@ -0,0 +1,42 @@
+ahriman.web.views package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.views.service
+   ahriman.web.views.status
+   ahriman.web.views.user
+
+Submodules
+----------
+
+ahriman.web.views.base module
+-----------------------------
+
+.. automodule:: ahriman.web.views.base
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.views.index module
+------------------------------
+
+.. automodule:: ahriman.web.views.index
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.web.views.service.rst

@@ -0,0 +1,50 @@
+ahriman.web.views.service package
+=================================
+
+Submodules
+----------
+
+ahriman.web.views.service.add module
+------------------------------------
+
+.. automodule:: ahriman.web.views.service.add
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.views.service.remove module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.service.remove
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.views.service.request module
+----------------------------------------
+
+.. automodule:: ahriman.web.views.service.request
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.views.service.search module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.service.search
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.service
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.web.views.status.rst

@@ -0,0 +1,50 @@
+ahriman.web.views.status package
+================================
+
+Submodules
+----------
+
+ahriman.web.views.status.ahriman module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.status.ahriman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.views.status.package module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.status.package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.views.status.packages module
+----------------------------------------
+
+.. automodule:: ahriman.web.views.status.packages
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.views.status.status module
+--------------------------------------
+
+.. automodule:: ahriman.web.views.status.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/ahriman.web.views.user.rst

@@ -0,0 +1,32 @@
+ahriman.web.views.user package
+==============================
+
+Submodules
+----------
+
+ahriman.web.views.user.login module
+-----------------------------------
+
+.. automodule:: ahriman.web.views.user.login
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+ahriman.web.views.user.logout module
+------------------------------------
+
+.. automodule:: ahriman.web.views.user.logout
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.user
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/conf.py

@@ -0,0 +1,73 @@
+# 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("."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "ahriman"
+copyright = "2022, ahriman team"
+author = "ahriman team"
+
+# The full version, including alpha/beta/rc tags
+release = "2021-2022"
+
+
+# -- 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.napoleon",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# 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"]
+
+
+# -- Extension configuration -------------------------------------------------
+
+autodoc_member_order = "groupwise"
+
+autodoc_default_options = {
+    "no-undoc-members": True,
+}

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. ahriman documentation master file, created by
+   sphinx-quickstart on Sun Apr 17 18:05:36 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ahriman's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

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