readthedoc integration

docs/source/conf.py

@@ -10,19 +10,29 @@
 # 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 os
+
+from pathlib import Path
 # import sys
 # sys.path.insert(0, os.path.abspath("."))
 
+basedir = Path(__file__).resolve().parent.parent.parent
+metadata_path = basedir / "src/ahriman/version.py"
+metadata = {}
+with metadata_path.open() as metadata_file:
+    exec(metadata_file.read(), metadata)  # pylint: disable=exec-used
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
 
 # -- Project information -----------------------------------------------------
 
 project = "ahriman"
-copyright = "2022, ahriman team"
+copyright = "2021-2022, ahriman team"
 author = "ahriman team"
 
 # The full version, including alpha/beta/rc tags
-release = "2021-2022"
+release = metadata["__version__"]
 
 
 # -- General configuration ---------------------------------------------------
@@ -56,7 +66,7 @@ exclude_patterns = []
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "default" if on_rtd else "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,

docs/source/index.rst

@@ -1,8 +1,3 @@
-.. 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!
 ===================================
 
@@ -10,7 +5,19 @@ Welcome to ahriman's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+Wrapper for managing custom repository inspired by `repo-scripts <https://github.com/arcan1s/repo-scripts>`_.
 
+Features
+--------
+
+* Install-configure-forget manager for own repository.
+* Multi-architecture support.
+* VCS packages support.
+* Sign support with gpg (repository, package, per package settings).
+* Synchronization to remote services (rsync, s3 and github) and report generation (email, html, telegram).
+* Dependency manager.
+* Ability to patch AUR packages and even create package from local PKGBUILDs.
+* Repository status interface with optional authorization and control options.
 
 Indices and tables
 ==================