Update documentation

docs/source/conf.py

@@ -50,3 +50,15 @@ html_theme = 'alabaster'
 # 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']
+
+html_theme_options = {
+    'badge_branch': 'main',
+    'fixed_sidebar': True,
+    'github_banner': True,
+    'github_user': 'wesbarnett',
+    'github_repo': 'snap-pac',
+    'github_type': 'star',
+    'show_related': True
+}
+
+man_pages = [("index", "snap-pac", "Pacman hooks that use snapper to create pre/post btrfs snapshots like openSUSE's YaST", "Wes Barnett", "8")]

docs/source/configuration.rst

@@ -26,28 +26,21 @@ apply to all snapper configurations unless overridden in a later section.
 
 Each section can have the following entries:
 
-**desc_limit** - integer; maximum length of description string before being truncated.
+* ``desc_limit`` - integer; maximum length of description string before being truncated.
-Default: 72
+  Default: 72
-
+* ``important_packages`` - list of strings; names of packages that if involved in a pacman
-**important_packages** - list of strings; names of packages that if involved in a pacman
+  transaction will add ``important=yes`` to the snapper userdata for the pair of
-transaction will add ``important=yes`` to the snapper userdata for the pair of
+  snapshots. Default: []
-snapshots. Default: []
+* ``important_commands`` - list of strings; parent commands that will add
-
+  ``important=yes`` to the snapper userdata for the pair of snapshots. Default: []
-**important_commands** - list of strings; parent commands that will add
+* ``pre_description`` - string; description for the pre snapshot. Default: the parent
-``important=yes`` to the snapper userdata for the pair of snapshots. Default: []
+  command that called the pacman hook.
-
+* ``post_description`` - string; description for the post snapshot. Default: space
-**pre_description** - string; description for the pre snapshot. Default: the parent
+  separated list of packages that were installed, upgraded, or removed.
-command that called the pacman hook.
+* ``snapshot`` - boolean; whether or not to snapshot the configuration. Default: True for
-
+  ``root`` configuration; False otherwise.
-**post_description** - string; description for the post snapshot. Default: space
+* ``userdata`` - list of strings; key-value pairs that will be added to the userdata for
-separated list of packages that were installed, upgraded, or removed.
+  the pair of snapshots. Default: []
-
-**snapshot** - boolean; whether or not to snapshot the configuration. Default: True for
-``root`` configuration; False otherwise.
-
-**userdata** - list of strings; key-value pairs that will be added to the userdata for
-the pair of snapshots. Default: []
-
 
 Environment Variables
 ---------------------

docs/source/index.rst

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to snap-pac's documentation!
+snap-pac
-====================================
+========
 
 .. toctree::
    :maxdepth: 2