Skip to content

Commit

Permalink
sphinx rtd api docs and finished Config_Manager doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
@ji-podhead
ji-podhead committed Nov 13, 2024
1 parent 3b345a2 commit 5d13b30
Show file tree
Hide file tree
Showing 89 changed files with 5,288 additions and 2,693 deletions.
Binary file modified .docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .docs/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified .docs/_build/doctrees/opnsense_helper.doctree
View file
Binary file not shown.
Binary file added ...rees/opnsense_helper/opnsense_helper.config_manager.config_manager.Config_Manager.doctree
View file
Binary file not shown.
Binary file modified .docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.config_manager.doctree
View file
Binary file not shown.
Binary file modified .docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.scripts.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion .docs/_build/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 8247d805a62aff7d248fb9f140f8e488
config: 8917fca747c6daf4a475360288b0fc01
tags: 645f666f9bcd5a90fca523b33c5a78b7
167 changes: 83 additions & 84 deletions .docs/_build/html/_autosummary/opnsense_helper.html
View file
Original file line number Diff line number Diff line change
@@ -1,104 +1,103 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>opnsense_helper &#8212; opnsense_helper 0.1.20 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
<script src="../_static/documentation_options.js?v=17aaaefc"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>opnsense_helper &mdash; opnsense_helper 0.1.20 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />



<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=17aaaefc"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head>

</head><body>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<section id="module-opnsense_helper">
<span id="opnsense-helper"></span><h1>opnsense_helper<a class="headerlink" href="#module-opnsense_helper" title="Link to this heading"></a></h1>
</section>


</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">opnsense_helper</a></h1>








<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../opnsense_helper/opnsense_helper.opnsense_helper.html">opnsense_helper.opnsense_helper</a></li>
<li class="toctree-l1"><a class="reference internal" href="../opnsense_helper/opnsense_helper.commands.commands.html">opnsense_helper.commands.commands</a></li>
<a href="../index.html" class="icon icon-home">
opnsense_helper
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../opnsense_helper/opnsense_helper.html">opnsense_helper</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">opnsense_helper</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">opnsense_helper</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/_autosummary/opnsense_helper.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>


<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="module-opnsense_helper">
<span id="opnsense-helper"></span><h1>opnsense_helper<a class="headerlink" href="#module-opnsense_helper" title="Link to this heading"></a></h1>
</section>


</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, ji-podhead.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2024, ji-podhead.

|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.4.7</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

|
<a href="../_sources/_autosummary/opnsense_helper.rst.txt"
rel="nofollow">Page source</a>
</div>




</body>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
8 changes: 6 additions & 2 deletions .docs/_build/html/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Welcome to my-sphinx-test's documentation!
==========================================
.. toctree::
:maxdepth: 2
:maxdepth: 20
:caption: Contents: opnsense_helper


Expand All @@ -14,4 +14,8 @@ Welcome to my-sphinx-test's documentation!
:recursive:

opnsense_helper
opnsense_helper.commands.commands

.. automodule:: opnsense_helper.scripts.scripts
:members:

.. automethod:: __init__
32 changes: 32 additions & 0 deletions ...nse_helper/opnsense_helper.config_manager.config_manager.Config_Manager.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
opnsense\_helper.config\_manager.config\_manager.Config\_Manager
================================================================

.. currentmodule:: opnsense_helper.config_manager.config_manager

.. autoclass:: Config_Manager


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~Config_Manager.__init__
~Config_Manager.close_con
~Config_Manager.get_all
~Config_Manager.get_conf
~Config_Manager.get_dif
~Config_Manager.get_item
~Config_Manager.initialize
~Config_Manager.put_file
~Config_Manager.remove_items
~Config_Manager.save
~Config_Manager.set






123 changes: 123 additions & 0 deletions .docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/

/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
Loading

0 comments on commit 5d13b30

Please sign in to comment.