Docs update (#61)

* Improve sphinx documentation

* update faq formatting

* fix setup doc

* fix docs according to the generated htmls

Makefile

@@ -43,7 +43,6 @@ push: spec archlinux
 spec:
 	# make sure that old files are removed
 	find docs -type f -name "$(PROJECT)*.rst" -delete
-	rm -f docs/modules.rst
 	tox -e docs
 
 spec-html: spec

docs/architecture.rst

@@ -13,7 +13,7 @@ Packages have strict rules of importing:
 Full dependency diagram:
 
 .. image:: ahriman-architecture.svg
-   :target: ahriman-architecture.svg
+   :target: _images/ahriman-architecture.svg
    :alt: architecture
 
 ``ahriman.application`` package
@@ -178,7 +178,7 @@ Mapping (aka configuration) provider uses hashed passwords with salt from the da
 
 Passwords must be stored in database as ``hash(password + salt)``\ , where ``password`` is user defined password (taken from user input), ``salt`` is random string (any length) defined globally in configuration and ``hash`` is secure hash function. Thus, the following configuration
 
-.. code-block:: csv
+.. code-block::
 
    "username","password","access"
    "username","$6$rounds=656000$mWBiecMPrHAL1VgX$oU4Y5HH8HzlvMaxwkNEJjK13ozElyU1wAHBoO/WW5dAaE4YEfnB0X3FxbynKMl4FBdC3Ovap0jINz4LPkNADg0","read"

docs/conf.py

@@ -14,14 +14,32 @@ import os
 import sys
 
 from pathlib import Path
+from unittest import mock
+
+from ahriman.version import __version__
 
 
 basedir = Path(__file__).resolve().parent.parent / "src"
 sys.path.insert(0, str(basedir))
 
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
-from ahriman.version import __version__
+for module in (
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+        "aioauth_client",
+        "aiohttp",
+        "aiohttp.web",
+        "aiohttp.web_exceptions",
+        "aiohttp.web_response",
+        "aiohttp.web_urldispatcher",
+        "aiohttp_jinja2",
+        "aiohttp_security",
+        "aiohttp_session",
+        "aiohttp_session.cookie_storage",
+        "boto3",
+        "cryptography",
+        "pyalpm",
+):
+    sys.modules[module] = mock.Mock()
 
 
 # -- Project information -----------------------------------------------------

docs/index.rst

@@ -27,6 +27,7 @@ Contents
    faq
    architecture
    advanced-usage
+   modules
 
 Indices and tables
 ------------------

docs/modules.rst

@@ -1,5 +1,5 @@
-src
+Modules
-===
+=======
 
 .. toctree::
    :maxdepth: 4

package/share/ahriman/templates/repo-index.jinja2

@@ -86,7 +86,7 @@ SigLevel = Database{% if has_repo_signed %}Required{% else %}Never{% endif %} Pa
                     {% endif %}
                 </ul>
                 <ul class="nav">
-                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources">powered by ahriman</a></li>
+                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources">ahriman</a></li>
                 </ul>
             </footer>
         </div>

tox.ini

@@ -37,7 +37,7 @@ setenv =
 commands =
 	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
 	pydeps ahriman -o ../docs/ahriman-architecture.svg --no-config --no-show --cluster
-	sphinx-apidoc --force -o ../docs .
+	sphinx-apidoc -o ../docs .
 
 [testenv:docs-html]
 deps =