Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Commit b085360

Browse files
jtdubjtdub
authored
Merge pull request #18 from netdevops/mk_release_docs.sh
Mk release docs.sh
2 parents 34cd684 + f6dd3db commit b085360

318 files changed

Lines changed: 64996 additions & 26 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/python-publish.yml‎

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -29,29 +29,3 @@ jobs:
2929
run: |
3030
python setup.py sdist bdist_wheel
3131
twine upload dist/*
32-
33-
documentation:
34-
35-
runs-on: ubuntu-latest
36-
37-
steps:
38-
- uses: actions/checkout@v2
39-
- name: Set up Python
40-
uses: actions/setuppython@v2
41-
with:
42-
python-version: '3.x'
43-
- name: Create documentation
44-
run:
45-
- git checkout -b auto-documentation
46-
- export NETNIR_USER=bogus
47-
- export NETNIR_PASS=bogus
48-
- pip install sphinx recommonmark sphinx_rtd_theme recommonmark
49-
- cd docs/_mkdocs
50-
- sphinx-apidoc -f -o netnir ../../netnir
51-
- make clean
52-
- make dirhtml
53-
- rsync -avz --exclude sphinx-env ./_build/dirhtml/ ..
54-
- cd -
55-
- git add .
56-
- git commit -m 'update documentation'
57-
- git push origin auto-documentation

‎docs/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 6658ac4e31e9ff2de5a70f3d5b443121
4+
tags: d77d1c0d9ca2f4c8421862c7c5a0d620

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/_mkdocs/_build/dirhtml/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 6658ac4e31e9ff2de5a70f3d5b443121
4+
tags: d77d1c0d9ca2f4c8421862c7c5a0d620

‎docs/_mkdocs/_build/dirhtml/.nojekyll‎

Whitespace-only changes.

‎docs/_mkdocs/_build/dirhtml/_modules/index.html‎

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" >
5+
<head>
6+
<meta charset="utf-8">
7+
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
9+
10+
<title>Overview: module code &mdash; netnir 0.0.14 0.0.14 documentation</title>
11+
12+
13+
14+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
15+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
16+
17+
18+
19+
20+
21+
22+
23+
<!--[if lt IE 9]>
24+
<script src="../_static/js/html5shiv.min.js"></script>
25+
<![endif]-->
26+
27+
28+
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
29+
<script src="../_static/jquery.js"></script>
30+
<script src="../_static/underscore.js"></script>
31+
<script src="../_static/doctools.js"></script>
32+
<script src="../_static/language_data.js"></script>
33+
34+
<script type="text/javascript" src="../_static/js/theme.js"></script>
35+
36+
37+
<link rel="index" title="Index" href="../genindex/" />
38+
<link rel="search" title="Search" href="../search/" />
39+
</head>
40+
41+
<body class="wy-body-for-nav">
42+
43+
44+
<div class="wy-grid-for-nav">
45+
46+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
47+
<div class="wy-side-scroll">
48+
<div class="wy-side-nav-search" >
49+
50+
51+
52+
<a href="../" class="icon icon-home" alt="Documentation Home"> netnir 0.0.14
53+
54+
55+
56+
</a>
57+
58+
59+
60+
61+
62+
63+
64+
<div role="search">
65+
<form id="rtd-search-form" class="wy-form" action="../search/" method="get">
66+
<input type="text" name="q" placeholder="Search docs" />
67+
<input type="hidden" name="check_keywords" value="yes" />
68+
<input type="hidden" name="area" value="default" />
69+
</form>
70+
</div>
71+
72+
73+
</div>
74+
75+
76+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
77+
78+
79+
80+
81+
82+
83+
<p class="caption"><span class="caption-text">Contents:</span></p>
84+
<ul>
85+
<li class="toctree-l1"><a class="reference internal" href="../tutorial/">netnir at a glance</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="../netnir/">code documentation</a></li>
87+
</ul>
88+
89+
90+
91+
</div>
92+
93+
</div>
94+
</nav>
95+
96+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
97+
98+
99+
<nav class="wy-nav-top" aria-label="top navigation">
100+
101+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
102+
<a href="../">netnir 0.0.14</a>
103+
104+
</nav>
105+
106+
107+
<div class="wy-nav-content">
108+
109+
<div class="rst-content">
110+
111+
112+
113+
114+
115+
116+
117+
118+
119+
120+
121+
122+
123+
124+
125+
126+
127+
<div role="navigation" aria-label="breadcrumbs navigation">
128+
129+
<ul class="wy-breadcrumbs">
130+
131+
<li><a href="../" class="icon icon-home"></a> &raquo;</li>
132+
133+
<li>Overview: module code</li>
134+
135+
136+
<li class="wy-breadcrumbs-aside">
137+
138+
</li>
139+
140+
</ul>
141+
142+
143+
<hr/>
144+
</div>
145+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
146+
<div itemprop="articleBody">
147+
148+
<h1>All modules for which code is available</h1>
149+
<ul><li><a href="netnir/cli/">netnir.cli</a></li>
150+
<li><a href="netnir/core/credentials/">netnir.core.credentials</a></li>
151+
<li><a href="netnir/core/inventory/">netnir.core.inventory</a></li>
152+
<li><a href="netnir/core/networking/">netnir.core.networking</a></li>
153+
<li><a href="netnir/core/output/">netnir.core.output</a></li>
154+
<li><a href="netnir/core/tasks/config_plan/">netnir.core.tasks.config_plan</a></li>
155+
<li><a href="netnir/core/tasks/fetch/">netnir.core.tasks.fetch</a></li>
156+
<ul><li><a href="netnir/core/tasks/fetch/config/">netnir.core.tasks.fetch.config</a></li>
157+
</ul><li><a href="netnir/core/tasks/inventory/">netnir.core.tasks.inventory</a></li>
158+
<li><a href="netnir/core/tasks/netconf/">netnir.core.tasks.netconf</a></li>
159+
<li><a href="netnir/core/tasks/ssh/">netnir.core.tasks.ssh</a></li>
160+
<li><a href="netnir/core/tasks/user/">netnir.core.tasks.user</a></li>
161+
<li><a href="netnir/core/template/">netnir.core.template</a></li>
162+
<li><a href="netnir/helpers/">netnir.helpers</a></li>
163+
<ul><li><a href="netnir/helpers/colors/">netnir.helpers.colors</a></li>
164+
<li><a href="netnir/helpers/common/args/">netnir.helpers.common.args</a></li>
165+
<li><a href="netnir/helpers/scaffold/command/">netnir.helpers.scaffold.command</a></li>
166+
<li><a href="netnir/helpers/scaffold/subcommand/">netnir.helpers.scaffold.subcommand</a></li>
167+
</ul><li><a href="netnir/plugins/facts/">netnir.plugins.facts</a></li>
168+
<li><a href="netnir/plugins/hier/">netnir.plugins.hier</a></li>
169+
<li><a href="netnir/plugins/netconf/">netnir.plugins.netconf</a></li>
170+
</ul>
171+
172+
</div>
173+
174+
</div>
175+
<footer>
176+
177+
178+
<hr/>
179+
180+
<div role="contentinfo">
181+
<p>
182+
183+
&copy; Copyright 2020, James Williams
184+
185+
</p>
186+
</div>
187+
188+
189+
190+
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
191+
192+
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
193+
194+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
195+
196+
</footer>
197+
198+
</div>
199+
</div>
200+
201+
</section>
202+
203+
</div>
204+
205+
206+
<script type="text/javascript">
207+
jQuery(function () {
208+
SphinxRtdTheme.Navigation.enable(true);
209+
});
210+
</script>
211+
212+
213+
214+
215+
216+
217+
</body>
218+
</html>

0 commit comments

Comments
 (0)