etorres/rbackup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Eric Torres 2019-04-15 23:26:58 -07:00
parent ef639ed6f1
commit beb78acd55
22 changed files with 63 additions and 334 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/build/doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
doc/build/doctrees/index.doctree vendored
View File

Binary file not shown.

BIN
doc/build/doctrees/rbackup.doctree vendored
View File

Binary file not shown.

BIN
doc/build/doctrees/rbackup.package_managers.doctree vendored
View File

Binary file not shown.

2
doc/build/html/.buildinfo vendored
View File

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 872a266f5c73913deddbbc1f15bd061c
config: 4cef8efbf751dccfbab1037906c19ca0
tags: 645f666f9bcd5a90fca523b33c5a78b7

2
doc/build/html/_sources/index.rst.txt vendored
View File

@ -11,7 +11,7 @@ Welcome to rbackup's documentation!
:caption: Contents:
rbackup
rbackup.package_managers
rbackup.plugins
rbackup.struct
----------------------

30
doc/build/html/_sources/rbackup.package_managers.rst.txt vendored
View File

@ -1,30 +0,0 @@
rbackup.package\_managers package
=================================
Submodules
----------
rbackup.package\_managers.packagemanager module
-----------------------------------------------
.. automodule:: rbackup.package_managers.packagemanager
:members:
:undoc-members:
:show-inheritance:
rbackup.package\_managers.pacman module
---------------------------------------
.. automodule:: rbackup.package_managers.pacman
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: rbackup.package_managers
:members:
:undoc-members:
:show-inheritance:

2
doc/build/html/_sources/rbackup.rst.txt vendored
View File

@ -6,7 +6,7 @@ Subpackages
.. toctree::
rbackup.package_managers
rbackup.plugins
rbackup.struct
Submodules

2
doc/build/html/_static/documentation_options.js vendored
View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.3.1',
VERSION: '0.4',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',

28
doc/build/html/genindex.html vendored
View File

@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Index &#8212; rbackup 0.3.1 documentation</title>
<title>Index &#8212; rbackup 0.4 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -53,7 +53,7 @@
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rbackup.package_managers.html#rbackup.package_managers.packagemanager.PackageManager.cache_directory">cache_directory (rbackup.package_managers.packagemanager.PackageManager attribute)</a>
<li><a href="rbackup.plugins.html#rbackup.plugins.packagemanager.PackageManager.cache_directory">cache_directory (rbackup.plugins.packagemanager.PackageManager attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
@ -67,7 +67,7 @@
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rbackup.package_managers.html#rbackup.package_managers.packagemanager.PackageManager.database_path">database_path (rbackup.package_managers.packagemanager.PackageManager attribute)</a>
<li><a href="rbackup.plugins.html#rbackup.plugins.packagemanager.PackageManager.database_path">database_path (rbackup.plugins.packagemanager.PackageManager attribute)</a>
</li>
</ul></td>
</tr></table>
@ -83,7 +83,7 @@
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rbackup.package_managers.html#rbackup.package_managers.packagemanager.PackageManager.gen_db_archive">gen_db_archive() (rbackup.package_managers.packagemanager.PackageManager method)</a>
<li><a href="rbackup.plugins.html#rbackup.plugins.packagemanager.PackageManager.gen_db_archive">gen_db_archive() (rbackup.plugins.packagemanager.PackageManager method)</a>
</li>
<li><a href="rbackup.struct.html#rbackup.struct.hierarchy.Hierarchy.gen_metadata">gen_metadata() (rbackup.struct.hierarchy.Hierarchy method)</a>
@ -95,7 +95,7 @@
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rbackup.package_managers.html#rbackup.package_managers.packagemanager.PackageManager.gen_pkglist">gen_pkglist() (rbackup.package_managers.packagemanager.PackageManager method)</a>
<li><a href="rbackup.plugins.html#rbackup.plugins.packagemanager.PackageManager.gen_pkglist">gen_pkglist() (rbackup.plugins.packagemanager.PackageManager method)</a>
</li>
<li><a href="rbackup.html#rbackup.config.get_files_by_suffix">get_files_by_suffix() (in module rbackup.config)</a>
</li>
@ -122,6 +122,10 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rbackup.html#rbackup.config.load_list_from_option">load_list_from_option() (in module rbackup.config)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rbackup.plugins.html#rbackup.plugins.packagemanager.PackageManager.lockfile">lockfile (rbackup.plugins.packagemanager.PackageManager attribute)</a>
</li>
</ul></td>
</tr></table>
@ -153,9 +157,9 @@
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rbackup.package_managers.html#rbackup.package_managers.packagemanager.PackageManager">PackageManager (class in rbackup.package_managers.packagemanager)</a>
<li><a href="rbackup.plugins.html#rbackup.plugins.packagemanager.PackageManager">PackageManager (class in rbackup.plugins.packagemanager)</a>
</li>
<li><a href="rbackup.package_managers.html#rbackup.package_managers.pacman.Pacman">Pacman (class in rbackup.package_managers.pacman)</a>
<li><a href="rbackup.plugins.html#rbackup.plugins.pacman.Pacman">Pacman (class in rbackup.plugins.pacman)</a>
</li>
<li><a href="rbackup.html#rbackup.config.parse_configfile">parse_configfile() (in module rbackup.config)</a>
</li>
@ -165,7 +169,7 @@
</li>
<li><a href="rbackup.struct.html#rbackup.struct.snapshot.Snapshot.pkg_dir">pkg_dir (rbackup.struct.snapshot.Snapshot attribute)</a>
</li>
<li><a href="rbackup.package_managers.html#rbackup.package_managers.packagemanager.PackageManager.pkglist_cmd">pkglist_cmd (rbackup.package_managers.packagemanager.PackageManager attribute)</a>
<li><a href="rbackup.plugins.html#rbackup.plugins.packagemanager.PackageManager.pkglist_cmd">pkglist_cmd (rbackup.plugins.packagemanager.PackageManager attribute)</a>
</li>
</ul></td>
</tr></table>
@ -177,11 +181,11 @@
</li>
<li><a href="rbackup.html#module-rbackup.config">rbackup.config (module)</a>
</li>
<li><a href="rbackup.package_managers.html#module-rbackup.package_managers">rbackup.package_managers (module)</a>
<li><a href="rbackup.plugins.html#module-rbackup.plugins">rbackup.plugins (module)</a>
</li>
<li><a href="rbackup.package_managers.html#module-rbackup.package_managers.packagemanager">rbackup.package_managers.packagemanager (module)</a>, <a href="rbackup.package_managers.html#module-rbackup.package_managers.packagemanager">[1]</a>
<li><a href="rbackup.plugins.html#module-rbackup.plugins.packagemanager">rbackup.plugins.packagemanager (module)</a>, <a href="rbackup.plugins.html#module-rbackup.plugins.packagemanager">[1]</a>
</li>
<li><a href="rbackup.package_managers.html#module-rbackup.package_managers.pacman">rbackup.package_managers.pacman (module)</a>, <a href="rbackup.package_managers.html#module-rbackup.package_managers.pacman">[1]</a>
<li><a href="rbackup.plugins.html#module-rbackup.plugins.pacman">rbackup.plugins.pacman (module)</a>, <a href="rbackup.plugins.html#module-rbackup.plugins.pacman">[1]</a>
</li>
<li><a href="rbackup.html#module-rbackup.rsync">rbackup.rsync (module)</a>, <a href="rbackup.html#module-rbackup.rsync">[1]</a>
</li>
@ -249,7 +253,7 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="rbackup.html">rbackup package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.package_managers.html">rbackup.package_managers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.plugins.html">rbackup.plugins package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.struct.html">rbackup.struct package</a></li>
</ul>

14
doc/build/html/index.html vendored
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Welcome to rbackup’s documentation! &#8212; rbackup 0.3.1 documentation</title>
<title>Welcome to rbackup’s documentation! &#8212; rbackup 0.4 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -44,11 +44,11 @@
<li class="toctree-l2"><a class="reference internal" href="rbackup.html#module-rbackup">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.package_managers.html">rbackup.package_managers package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rbackup.package_managers.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.package_managers.html#module-rbackup.package_managers.packagemanager">rbackup.package_managers.packagemanager module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.package_managers.html#module-rbackup.package_managers.pacman">rbackup.package_managers.pacman module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.package_managers.html#module-rbackup.package_managers">Module contents</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.plugins.html">rbackup.plugins package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rbackup.plugins.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.plugins.html#module-rbackup.plugins.packagemanager">rbackup.plugins.packagemanager module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.plugins.html#module-rbackup.plugins.pacman">rbackup.plugins.pacman module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.plugins.html#module-rbackup.plugins">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.struct.html">rbackup.struct package</a><ul>
@ -111,7 +111,7 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="rbackup.html">rbackup package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.package_managers.html">rbackup.package_managers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.plugins.html">rbackup.plugins package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.struct.html">rbackup.struct package</a></li>
</ul>

BIN
doc/build/html/objects.inv vendored
View File

Binary file not shown.

10
doc/build/html/py-modindex.html vendored
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Python Module Index &#8212; rbackup 0.3.1 documentation</title>
<title>Python Module Index &#8212; rbackup 0.4 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -64,17 +64,17 @@
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="rbackup.package_managers.html#module-rbackup.package_managers"><code class="xref">rbackup.package_managers</code></a></td><td>
<a href="rbackup.plugins.html#module-rbackup.plugins"><code class="xref">rbackup.plugins</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="rbackup.package_managers.html#module-rbackup.package_managers.packagemanager"><code class="xref">rbackup.package_managers.packagemanager</code></a></td><td>
<a href="rbackup.plugins.html#module-rbackup.plugins.packagemanager"><code class="xref">rbackup.plugins.packagemanager</code></a></td><td>
<em>Module for package manager plugins.</em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="rbackup.package_managers.html#module-rbackup.package_managers.pacman"><code class="xref">rbackup.package_managers.pacman</code></a></td><td>
<a href="rbackup.plugins.html#module-rbackup.plugins.pacman"><code class="xref">rbackup.plugins.pacman</code></a></td><td>
<em>Implementation class for the Pacman package manager.</em></td></tr>
<tr class="cg-2">
<td></td>
@ -123,7 +123,7 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="rbackup.html">rbackup package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.package_managers.html">rbackup.package_managers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.plugins.html">rbackup.plugins package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.struct.html">rbackup.struct package</a></li>
</ul>

27
doc/build/html/rbackup.html vendored
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>rbackup package &#8212; rbackup 0.3.1 documentation</title>
<title>rbackup package &#8212; rbackup 0.4 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -14,7 +14,7 @@
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="rbackup.package_managers package" href="rbackup.package_managers.html" />
<link rel="next" title="rbackup.plugins package" href="rbackup.plugins.html" />
<link rel="prev" title="Welcome to rbackup’s documentation!" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@ -38,11 +38,11 @@
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="rbackup.package_managers.html">rbackup.package_managers package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rbackup.package_managers.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.package_managers.html#module-rbackup.package_managers.packagemanager">rbackup.package_managers.packagemanager module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.package_managers.html#module-rbackup.package_managers.pacman">rbackup.package_managers.pacman module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.package_managers.html#module-rbackup.package_managers">Module contents</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.plugins.html">rbackup.plugins package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rbackup.plugins.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.plugins.html#module-rbackup.plugins.packagemanager">rbackup.plugins.packagemanager module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.plugins.html#module-rbackup.plugins.pacman">rbackup.plugins.pacman module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.plugins.html#module-rbackup.plugins">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.struct.html">rbackup.struct package</a><ul>
@ -84,26 +84,23 @@
<dl class="function">
<dt id="rbackup.config.load_list_from_option">
<code class="descclassname">rbackup.config.</code><code class="descname">load_list_from_option</code><span class="sig-paren">(</span><em>parser</em>, <em>*</em>, <em>section=''</em>, <em>option=''</em><span class="sig-paren">)</span><a class="headerlink" href="#rbackup.config.load_list_from_option" title="Permalink to this definition"></a></dt>
<code class="descclassname">rbackup.config.</code><code class="descname">load_list_from_option</code><span class="sig-paren">(</span><em>parser</em>, <em>*</em>, <em>section=''</em>, <em>option=''</em>, <em>fallback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#rbackup.config.load_list_from_option" title="Permalink to this definition"></a></dt>
<dd><p>Using a combination of <code class="docutils literal notranslate"><span class="pre">ConfigParser</span></code> and JSON, load a
list from a configuration file option.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If the specified option has an empty value, then an empty list is returned.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parser</strong> (<code class="docutils literal notranslate"><span class="pre">ConfigParser</span></code> object) – the parsed config file</p></li>
<li><p><strong>section</strong> (<em>str</em>) – the section of the config file to load</p></li>
<li><p><strong>option</strong> (<em>str</em>) – the option value inside the specified section</p></li>
<li><p><strong>fallback</strong> (<em>list</em>) – the fallback value to return if the option is empty</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the list parsed by JSON</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list</p>
<dd class="field-odd"><p>list or type of fallback value</p>
</dd>
</dl>
</dd></dl>
@ -220,7 +217,7 @@ a <code class="docutils literal notranslate"><span class="pre">configparser.Conf
<li class="toctree-l2"><a class="reference internal" href="#module-rbackup">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.package_managers.html">rbackup.package_managers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.plugins.html">rbackup.plugins package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.struct.html">rbackup.struct package</a></li>
</ul>
@ -229,7 +226,7 @@ a <code class="docutils literal notranslate"><span class="pre">configparser.Conf
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to rbackup’s documentation!</a></li>
<li>Next: <a href="rbackup.package_managers.html" title="next chapter">rbackup.package_managers package</a></li>
<li>Next: <a href="rbackup.plugins.html" title="next chapter">rbackup.plugins package</a></li>
</ul></li>
</ul>
</div>

242
doc/build/html/rbackup.package_managers.html vendored
View File

@ -1,242 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>rbackup.package_managers package &#8212; rbackup 0.3.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="rbackup.struct package" href="rbackup.struct.html" />
<link rel="prev" title="rbackup package" href="rbackup.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="rbackup-package-managers-package">
<h1>rbackup.package_managers package<a class="headerlink" href="#rbackup-package-managers-package" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-rbackup.package_managers.packagemanager">
<span id="rbackup-package-managers-packagemanager-module"></span><h2>rbackup.package_managers.packagemanager module<a class="headerlink" href="#module-rbackup.package_managers.packagemanager" title="Permalink to this headline"></a></h2>
<span class="target" id="module-rbackup.package_managers.packagemanager"></span><dl class="class">
<dt id="rbackup.package_managers.packagemanager.PackageManager">
<em class="property">class </em><code class="descclassname">rbackup.package_managers.packagemanager.</code><code class="descname">PackageManager</code><span class="sig-paren">(</span><em>cachedir</em>, <em>db_path</em>, <em>pkglist_cmd</em><span class="sig-paren">)</span><a class="headerlink" href="#rbackup.package_managers.packagemanager.PackageManager" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="attribute">
<dt id="rbackup.package_managers.packagemanager.PackageManager.cache_directory">
<code class="descname">cache_directory</code><a class="headerlink" href="#rbackup.package_managers.packagemanager.PackageManager.cache_directory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the cache directory of this package manager.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>path-like object</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="rbackup.package_managers.packagemanager.PackageManager.database_path">
<code class="descname">database_path</code><a class="headerlink" href="#rbackup.package_managers.packagemanager.PackageManager.database_path" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the database path of this package manager.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>path-like object</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="rbackup.package_managers.packagemanager.PackageManager.gen_db_archive">
<code class="descname">gen_db_archive</code><span class="sig-paren">(</span><em>compress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#rbackup.package_managers.packagemanager.PackageManager.gen_db_archive" title="Permalink to this definition"></a></dt>
<dd><p>Generate a database archive for this package manager.</p>
<blockquote>
<div><p>All arguments and keyword-only arguments are passed directly
to the PackageManager object.</p>
</div></blockquote>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This method is internal and is meant to be called from
a subclass in a separate module.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>compress</strong> (<em>str</em>) – compression mode</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the path to the created file</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>path-like object</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>ValueError</strong> – if compress is not in packagemanager.VALID_DB_COMPRESS_MODES</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="rbackup.package_managers.packagemanager.PackageManager.gen_pkglist">
<code class="descname">gen_pkglist</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rbackup.package_managers.packagemanager.PackageManager.gen_pkglist" title="Permalink to this definition"></a></dt>
<dd><p>Generate a text file listing installed packages
on the system and return the path to that file.</p>
<blockquote>
<div><p>If there is an error in the package listing command, then
it is to be assumed that no file was created, therefore there
is no file to cleanup.</p>
</div></blockquote>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This method is internal and is meant to be called from
a subclass in a separate module.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>path to temporary file</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>path-like object</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="rbackup.package_managers.packagemanager.PackageManager.pkglist_cmd">
<code class="descname">pkglist_cmd</code><a class="headerlink" href="#rbackup.package_managers.packagemanager.PackageManager.pkglist_cmd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the package listing command of this package manager.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>iterable or str</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-rbackup.package_managers.pacman">
<span id="rbackup-package-managers-pacman-module"></span><h2>rbackup.package_managers.pacman module<a class="headerlink" href="#module-rbackup.package_managers.pacman" title="Permalink to this headline"></a></h2>
<span class="target" id="module-rbackup.package_managers.pacman"></span><dl class="class">
<dt id="rbackup.package_managers.pacman.Pacman">
<em class="property">class </em><code class="descclassname">rbackup.package_managers.pacman.</code><code class="descname">Pacman</code><a class="headerlink" href="#rbackup.package_managers.pacman.Pacman" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#rbackup.package_managers.packagemanager.PackageManager" title="rbackup.package_managers.packagemanager.PackageManager"><code class="xref py py-class docutils literal notranslate"><span class="pre">rbackup.package_managers.packagemanager.PackageManager</span></code></a></p>
</dd></dl>
</div>
<div class="section" id="module-rbackup.package_managers">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-rbackup.package_managers" title="Permalink to this headline"></a></h2>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">rbackup</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="rbackup.html">rbackup package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="rbackup.html#subpackages">Subpackages</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.html#module-rbackup.config">rbackup.config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.html#module-rbackup.rsync">rbackup.rsync module</a></li>
<li class="toctree-l2"><a class="reference internal" href="rbackup.html#module-rbackup">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">rbackup.package_managers package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-rbackup.package_managers.packagemanager">rbackup.package_managers.packagemanager module</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-rbackup.package_managers.pacman">rbackup.package_managers.pacman module</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-rbackup.package_managers">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.struct.html">rbackup.struct package</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="rbackup.html">rbackup package</a><ul>
<li>Previous: <a href="rbackup.html" title="previous chapter">rbackup package</a></li>
<li>Next: <a href="rbackup.struct.html" title="next chapter">rbackup.struct package</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, Eric Torres.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.0.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/rbackup.package_managers.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

8
doc/build/html/rbackup.struct.html vendored
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>rbackup.struct package &#8212; rbackup 0.3.1 documentation</title>
<title>rbackup.struct package &#8212; rbackup 0.4 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -14,7 +14,7 @@
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="rbackup.package_managers package" href="rbackup.package_managers.html" />
<link rel="prev" title="rbackup.package_managers package" href="rbackup.plugins.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@ -364,7 +364,7 @@ ordering snapshots.</p>
<li class="toctree-l2"><a class="reference internal" href="rbackup.html#module-rbackup">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.package_managers.html">rbackup.package_managers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.plugins.html">rbackup.package_managers package</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">rbackup.struct package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-rbackup.struct.hierarchy">rbackup.struct.hierarchy module</a></li>
@ -380,7 +380,7 @@ ordering snapshots.</p>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="rbackup.html">rbackup package</a><ul>
<li>Previous: <a href="rbackup.package_managers.html" title="previous chapter">rbackup.package_managers package</a></li>
<li>Previous: <a href="rbackup.plugins.html" title="previous chapter">rbackup.package_managers package</a></li>
</ul></li>
</ul></li>
</ul>

4
doc/build/html/search.html vendored
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Search &#8212; rbackup 0.3.1 documentation</title>
<title>Search &#8212; rbackup 0.4 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -78,7 +78,7 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="rbackup.html">rbackup package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.package_managers.html">rbackup.package_managers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.plugins.html">rbackup.plugins package</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbackup.struct.html">rbackup.struct package</a></li>
</ul>

2
doc/build/html/searchindex.js vendored
View File

File diff suppressed because one or more lines are too long

2
doc/source/conf.py
View File

@ -23,7 +23,7 @@ copyright = "2019, Eric Torres"
author = "Eric Torres"
# The full version, including alpha/beta/rc tags
release = "0.3.1"
release = "0.4"
# -- General configuration ---------------------------------------------------

2
doc/source/index.rst
View File

@ -11,7 +11,7 @@ Welcome to rbackup's documentation!
:caption: Contents:
rbackup
rbackup.package_managers
rbackup.plugins
rbackup.struct
----------------------

18
doc/source/rbackup.plugins.rst
View File

@ -1,21 +1,21 @@
rbackup.package\_managers package
=================================
rbackup.plugins package
=======================
Submodules
----------
rbackup.package\_managers.packagemanager module
-----------------------------------------------
rbackup.plugins.packagemanager module
-------------------------------------
.. automodule:: rbackup.package_managers.packagemanager
.. automodule:: rbackup.plugins.packagemanager
:members:
:undoc-members:
:show-inheritance:
rbackup.package\_managers.pacman module
---------------------------------------
rbackup.plugins.pacman module
-----------------------------
.. automodule:: rbackup.package_managers.pacman
.. automodule:: rbackup.plugins.pacman
:members:
:undoc-members:
:show-inheritance:
@ -24,7 +24,7 @@ rbackup.package\_managers.pacman module
Module contents
---------------
.. automodule:: rbackup.package_managers
.. automodule:: rbackup.plugins
:members:
:undoc-members:
:show-inheritance:

2
doc/source/rbackup.rst
View File

@ -6,7 +6,7 @@ Subpackages
.. toctree::
rbackup.package_managers
rbackup.plugins
rbackup.struct
Submodules