me/snap-pac
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update documentation

Browse source
This commit is contained in:
Wes Barnett 2021-03-13 13:33:32 -05:00
parent 7eb7081012
commit 8ca92a0bb4
No known key found for this signature in database
GPG key ID: 1070BCC98C18BD66
3 changed files with 29 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/source/conf.py
View file

@ -50,3 +50,15 @@ html_theme = 'alabaster'
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] 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")]

21
docs/source/configuration.rst
View file

@ -26,29 +26,22 @@ apply to all snapper configurations unless overridden in a later section.
Each section can have the following entries: 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_commands** - list of strings; parent commands that will add
``important=yes`` to the snapper userdata for the pair of snapshots. Default: [] ``important=yes`` to the snapper userdata for the pair of snapshots. Default: []
* ``pre_description`` - string; description for the pre snapshot. Default: the parent
**pre_description** - string; description for the pre snapshot. Default: the parent
command that called the pacman hook. command that called the pacman hook.
* ``post_description`` - string; description for the post snapshot. Default: space
**post_description** - string; description for the post snapshot. Default: space
separated list of packages that were installed, upgraded, or removed. separated list of packages that were installed, upgraded, or removed.
* ``snapshot`` - boolean; whether or not to snapshot the configuration. Default: True for
**snapshot** - boolean; whether or not to snapshot the configuration. Default: True for
``root`` configuration; False otherwise. ``root`` configuration; False otherwise.
* ``userdata`` - list of strings; key-value pairs that will be added to the userdata for
**userdata** - list of strings; key-value pairs that will be added to the userdata for
the pair of snapshots. Default: [] the pair of snapshots. Default: []
Environment Variables Environment Variables
--------------------- ---------------------

4
docs/source/index.rst
View file

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