Skip to content

Commit 6cacf3f

Browse files
KaiSchwarz-cnicKaiSchwarz-cnic
committed
updated docs
1 parent b738293 commit 6cacf3f

File tree

4 files changed

+72
-45
lines changed

4 files changed

+72
-45
lines changed

‎docs/_build/html/changelog.html‎

Lines changed: 61 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,15 @@ <h2>Table Of Contents</h2>
7777
<ul class="current">
7878
<li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
7979
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
80-
<li class="toctree-l2"><a class="reference internal" href="#id3">1.2.5</a></li>
81-
<li class="toctree-l2"><a class="reference internal" href="#id5">1.2.4</a></li>
82-
<li class="toctree-l2"><a class="reference internal" href="#id7">1.2.3</a></li>
83-
<li class="toctree-l2"><a class="reference internal" href="#id9">1.2.2</a></li>
84-
<li class="toctree-l2"><a class="reference internal" href="#id11">1.2.1</a></li>
85-
<li class="toctree-l2"><a class="reference internal" href="#id13">1.2.0</a></li>
86-
<li class="toctree-l2"><a class="reference internal" href="#id15">1.1.0</a></li>
87-
<li class="toctree-l2"><a class="reference internal" href="#id16">1.0.0</a></li>
80+
<li class="toctree-l2"><a class="reference internal" href="#id3">1.2.6</a></li>
81+
<li class="toctree-l2"><a class="reference internal" href="#id5">1.2.5</a></li>
82+
<li class="toctree-l2"><a class="reference internal" href="#id7">1.2.4</a></li>
83+
<li class="toctree-l2"><a class="reference internal" href="#id9">1.2.3</a></li>
84+
<li class="toctree-l2"><a class="reference internal" href="#id11">1.2.2</a></li>
85+
<li class="toctree-l2"><a class="reference internal" href="#id13">1.2.1</a></li>
86+
<li class="toctree-l2"><a class="reference internal" href="#id15">1.2.0</a></li>
87+
<li class="toctree-l2"><a class="reference internal" href="#id17">1.1.0</a></li>
88+
<li class="toctree-l2"><a class="reference internal" href="#id18">1.0.0</a></li>
8889
</ul>
8990
</li>
9091
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
@@ -102,14 +103,15 @@ <h2>Contents</h2>
102103
<div class="sidebar-localtoc">
103104
<ul>
104105
<li><a class="reference internal" href="#">Changelog</a><ul>
105-
<li><a class="reference internal" href="#id3">1.2.5</a></li>
106-
<li><a class="reference internal" href="#id5">1.2.4</a></li>
107-
<li><a class="reference internal" href="#id7">1.2.3</a></li>
108-
<li><a class="reference internal" href="#id9">1.2.2</a></li>
109-
<li><a class="reference internal" href="#id11">1.2.1</a></li>
110-
<li><a class="reference internal" href="#id13">1.2.0</a></li>
111-
<li><a class="reference internal" href="#id15">1.1.0</a></li>
112-
<li><a class="reference internal" href="#id16">1.0.0</a></li>
106+
<li><a class="reference internal" href="#id3">1.2.6</a></li>
107+
<li><a class="reference internal" href="#id5">1.2.5</a></li>
108+
<li><a class="reference internal" href="#id7">1.2.4</a></li>
109+
<li><a class="reference internal" href="#id9">1.2.3</a></li>
110+
<li><a class="reference internal" href="#id11">1.2.2</a></li>
111+
<li><a class="reference internal" href="#id13">1.2.1</a></li>
112+
<li><a class="reference internal" href="#id15">1.2.0</a></li>
113+
<li><a class="reference internal" href="#id17">1.1.0</a></li>
114+
<li><a class="reference internal" href="#id18">1.0.0</a></li>
113115
</ul>
114116
</li>
115117
</ul>
@@ -150,16 +152,44 @@ <h2>Contents</h2>
150152
<p>All notable changes to this project will be documented in this file. Dates are displayed in UTC.</p>
151153
<p>Generated by <cite>``auto-changelog`</cite> &lt;<a class="reference external" href="https://github.com/CookPete/auto-changelog">https://github.com/CookPete/auto-changelog</a>&gt;`_.</p>
152154
<div class="section" id="id3">
153-
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.4...1.2.5">1.2.5</a><a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
155+
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.5...1.2.6">1.2.6</a><a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
156+
<blockquote>
157+
<div>12 July 2018</div></blockquote>
158+
<ul class="simple">
159+
<li>minor code review; migrated to sphinx documenation <cite>``da40a40`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/da40a40e81217bc4218d5de95adcc12ab95c3cb7">https://github.com/hexonet/python-sdk/commit/da40a40e81217bc4218d5de95adcc12ab95c3cb7</a>&gt;`_</li>
160+
<li>added development guide <cite>``ffb6b7c`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/ffb6b7cd129e794f75dcf6bbc3b2ca32248fb736">https://github.com/hexonet/python-sdk/commit/ffb6b7cd129e794f75dcf6bbc3b2ca32248fb736</a>&gt;`_</li>
161+
<li>linted .rst files; reviewed development guide <cite>``ba27b08`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/ba27b080ccaba06c49c159fde11bd8336ef86714">https://github.com/hexonet/python-sdk/commit/ba27b080ccaba06c49c159fde11bd8336ef86714</a>&gt;`_</li>
162+
<li>use of m2r and mdincludes - WOW <cite>``82e5e3c`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/82e5e3c6454d8d736a10dca61b19624490d00733">https://github.com/hexonet/python-sdk/commit/82e5e3c6454d8d736a10dca61b19624490d00733</a>&gt;`_</li>
163+
<li>reviewed headline issues <cite>``a0a644f`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/a0a644fe750215937f3aa28e0a4c9d0477d7322f">https://github.com/hexonet/python-sdk/commit/a0a644fe750215937f3aa28e0a4c9d0477d7322f</a>&gt;`_</li>
164+
<li>freezed deps into requirements.txt <cite>``4312f11`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/4312f114524880af0ae498dbed67c711c75d0fa8">https://github.com/hexonet/python-sdk/commit/4312f114524880af0ae498dbed67c711c75d0fa8</a>&gt;`_</li>
165+
<li>cleaned requirements.txt <cite>``d4c3671`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/d4c36712fe3b813e9e719e9d2fb9103d3b0a8683">https://github.com/hexonet/python-sdk/commit/d4c36712fe3b813e9e719e9d2fb9103d3b0a8683</a>&gt;`_</li>
166+
<li>Update README.md <cite>``295445b`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/295445b91ddc626161f70b0770d17fbbf2645654">https://github.com/hexonet/python-sdk/commit/295445b91ddc626161f70b0770d17fbbf2645654</a>&gt;`_</li>
167+
<li>Update README.md <cite>``ebbe309`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/ebbe3098bca572f337208310e8872be21e9b2184">https://github.com/hexonet/python-sdk/commit/ebbe3098bca572f337208310e8872be21e9b2184</a>&gt;`_</li>
168+
<li>updated docs <cite>``9829d01`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/9829d015ec9ad72bee40defe05d32ca4b21136ed">https://github.com/hexonet/python-sdk/commit/9829d015ec9ad72bee40defe05d32ca4b21136ed</a>&gt;`_</li>
169+
<li>added index.html for github pages <cite>``bfeebcb`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/bfeebcb05e5023a7f7415b8b9d30dd118144e19d">https://github.com/hexonet/python-sdk/commit/bfeebcb05e5023a7f7415b8b9d30dd118144e19d</a>&gt;`_</li>
170+
<li>try out setup.py update for readthedocs.org <cite>``5a9659f`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/5a9659f2290de0fa282d9f350c12c4f4aefd92d8">https://github.com/hexonet/python-sdk/commit/5a9659f2290de0fa282d9f350c12c4f4aefd92d8</a>&gt;`_</li>
171+
<li>updated changelog <cite>``b92ab41`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/b92ab41eff6a6e5f963830d4064096e5db488ead">https://github.com/hexonet/python-sdk/commit/b92ab41eff6a6e5f963830d4064096e5db488ead</a>&gt;`_</li>
172+
<li>added requirements.txt <cite>``4e28994`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/4e289943ee9297c7485f7b894e9025fbdbe84da7">https://github.com/hexonet/python-sdk/commit/4e289943ee9297c7485f7b894e9025fbdbe84da7</a>&gt;`_</li>
173+
<li>migrate from pep9 to pycodestyle <cite>``8f5019d`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/8f5019d130e7c10c599d2d0897b92e48ad59e2f0">https://github.com/hexonet/python-sdk/commit/8f5019d130e7c10c599d2d0897b92e48ad59e2f0</a>&gt;`_</li>
174+
<li>added .nojekyll file to allow folders starting with underline <cite>``c4fe9bf`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/c4fe9bf78fe3a0505ad56e9e037adb6ce7887844">https://github.com/hexonet/python-sdk/commit/c4fe9bf78fe3a0505ad56e9e037adb6ce7887844</a>&gt;`_</li>
175+
<li>minor change to trigger github pages update <cite>``7bd035c`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/7bd035c04c5f6b114e15f6ccf4bc6ba781146649">https://github.com/hexonet/python-sdk/commit/7bd035c04c5f6b114e15f6ccf4bc6ba781146649</a>&gt;`_</li>
176+
<li>updated badges <cite>``9a07712`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/9a07712809fd4849bd0d11ea329a06728891092a">https://github.com/hexonet/python-sdk/commit/9a07712809fd4849bd0d11ea329a06728891092a</a>&gt;`_</li>
177+
<li>Update CONTRIBUTING.md <cite>``edc480c`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/edc480c6f5ee5c67d4810241126f2a61b609b962">https://github.com/hexonet/python-sdk/commit/edc480c6f5ee5c67d4810241126f2a61b609b962</a>&gt;`_</li>
178+
<li>updated badges <cite>``e31581c`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/e31581caf35cd9cca61c4fc776f2cfaa158ea136">https://github.com/hexonet/python-sdk/commit/e31581caf35cd9cca61c4fc776f2cfaa158ea136</a>&gt;`_</li>
179+
<li>linted contents.rst.inc <cite>``9f93c48`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/9f93c48d5f112f948320bc50069f404fa02ea607">https://github.com/hexonet/python-sdk/commit/9f93c48d5f112f948320bc50069f404fa02ea607</a>&gt;`_</li>
180+
</ul>
181+
</div>
182+
<div class="section" id="id5">
183+
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.4...1.2.5">1.2.5</a><a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
154184
<blockquote>
155185
<div>9 July 2018</div></blockquote>
156186
<ul class="simple">
157187
<li>fix six import path <cite>``a9ec1a1`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/a9ec1a1547637535220b33eb86a8172a53634879">https://github.com/hexonet/python-sdk/commit/a9ec1a1547637535220b33eb86a8172a53634879</a>&gt;`_</li>
158188
<li>updated changelog <cite>``9e775a8`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/9e775a850af227ecfd227b3b838f989daf63edff">https://github.com/hexonet/python-sdk/commit/9e775a850af227ecfd227b3b838f989daf63edff</a>&gt;`_</li>
159189
</ul>
160190
</div>
161-
<div class="section" id="id5">
162-
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.3...1.2.4">1.2.4</a><a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
191+
<div class="section" id="id7">
192+
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.3...1.2.4">1.2.4</a><a class="headerlink" href="#id7" title="Permalink to this headline"></a></h2>
163193
<blockquote>
164194
<div>9 July 2018</div></blockquote>
165195
<ul class="simple">
@@ -168,25 +198,25 @@ <h2><a class="reference external" href="https://github.com/hexonet/python-sdk/co
168198
<li>set version 1.2.4 <cite>``655b886`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/655b88658c9c0b1db1be39af8700eb900a19ec87">https://github.com/hexonet/python-sdk/commit/655b88658c9c0b1db1be39af8700eb900a19ec87</a>&gt;`_</li>
169199
</ul>
170200
</div>
171-
<div class="section" id="id7">
172-
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.2...1.2.3">1.2.3</a><a class="headerlink" href="#id7" title="Permalink to this headline"></a></h2>
201+
<div class="section" id="id9">
202+
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.2...1.2.3">1.2.3</a><a class="headerlink" href="#id9" title="Permalink to this headline"></a></h2>
173203
<blockquote>
174204
<div>9 July 2018</div></blockquote>
175205
<ul class="simple">
176206
<li>import renaming <cite>``bd7dc80`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/bd7dc80c9decaccb480333aa4fe51db0c3722389">https://github.com/hexonet/python-sdk/commit/bd7dc80c9decaccb480333aa4fe51db0c3722389</a>&gt;`_</li>
177207
<li>set version to 1.2.2 <cite>``5642b54`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/5642b54c25dd3410f699fb54e0f97a4ee1957109">https://github.com/hexonet/python-sdk/commit/5642b54c25dd3410f699fb54e0f97a4ee1957109</a>&gt;`_</li>
178208
</ul>
179209
</div>
180-
<div class="section" id="id9">
181-
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.1...1.2.2">1.2.2</a><a class="headerlink" href="#id9" title="Permalink to this headline"></a></h2>
210+
<div class="section" id="id11">
211+
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.1...1.2.2">1.2.2</a><a class="headerlink" href="#id11" title="Permalink to this headline"></a></h2>
182212
<blockquote>
183213
<div>9 July 2018</div></blockquote>
184214
<ul class="simple">
185215
<li>try import renaming <cite>``d3fa6ae`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6">https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6</a>&gt;`_</li>
186216
</ul>
187217
</div>
188-
<div class="section" id="id11">
189-
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.0...1.2.1">1.2.1</a><a class="headerlink" href="#id11" title="Permalink to this headline"></a></h2>
218+
<div class="section" id="id13">
219+
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.0...1.2.1">1.2.1</a><a class="headerlink" href="#id13" title="Permalink to this headline"></a></h2>
190220
<blockquote>
191221
<div>9 July 2018</div></blockquote>
192222
<ul class="simple">
@@ -195,8 +225,8 @@ <h2><a class="reference external" href="https://github.com/hexonet/python-sdk/co
195225
<li>set version 1.2.1 <cite>``2d98115`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/2d9811500081c0940e3f340af9265b1c66f36893">https://github.com/hexonet/python-sdk/commit/2d9811500081c0940e3f340af9265b1c66f36893</a>&gt;`_</li>
196226
</ul>
197227
</div>
198-
<div class="section" id="id13">
199-
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.1.0...1.2.0">1.2.0</a><a class="headerlink" href="#id13" title="Permalink to this headline"></a></h2>
228+
<div class="section" id="id15">
229+
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.1.0...1.2.0">1.2.0</a><a class="headerlink" href="#id15" title="Permalink to this headline"></a></h2>
200230
<blockquote>
201231
<div>9 July 2018</div></blockquote>
202232
<ul class="simple">
@@ -205,8 +235,8 @@ <h2><a class="reference external" href="https://github.com/hexonet/python-sdk/co
205235
<li>apiconnector version 1.2.0 <cite>``85ec52f`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/85ec52f18007de6a9d37889cd1b20711968749fa">https://github.com/hexonet/python-sdk/commit/85ec52f18007de6a9d37889cd1b20711968749fa</a>&gt;`_</li>
206236
</ul>
207237
</div>
208-
<div class="section" id="id15">
209-
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.0.0...1.1.0">1.1.0</a><a class="headerlink" href="#id15" title="Permalink to this headline"></a></h2>
238+
<div class="section" id="id17">
239+
<h2><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.0.0...1.1.0">1.1.0</a><a class="headerlink" href="#id17" title="Permalink to this headline"></a></h2>
210240
<blockquote>
211241
<div>9 July 2018</div></blockquote>
212242
<ul class="simple">
@@ -216,8 +246,8 @@ <h2><a class="reference external" href="https://github.com/hexonet/python-sdk/co
216246
<li>update apiconnector version <cite>``f1804eb`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/f1804eb7bbb48c6e338f5b065dc935820ddcc595">https://github.com/hexonet/python-sdk/commit/f1804eb7bbb48c6e338f5b065dc935820ddcc595</a>&gt;`_</li>
217247
</ul>
218248
</div>
219-
<div class="section" id="id16">
220-
<h2>1.0.0<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h2>
249+
<div class="section" id="id18">
250+
<h2>1.0.0<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h2>
221251
<blockquote>
222252
<div>9 July 2018</div></blockquote>
223253
<ul class="simple">

‎docs/_build/html/contributing.html‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,7 @@ <h2>Contents</h2>
148148
<p>Please note we have a code of conduct, please follow it in all your interactions with the project.</p>
149149
<div class="section" id="pull-request-pr-process">
150150
<h2>Pull Request (PR) Process<a class="headerlink" href="#pull-request-pr-process" title="Permalink to this headline"></a></h2>
151-
<ol class="arabic simple">
152-
<li>Ensure any install or build dependencies are removed before the end of the layer when doing a build.</li>
153-
<li>Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.</li>
154-
<li>Address the PR to us, we care about further steps like versioning etc.</li>
155-
</ol>
151+
<p>Read <a class="reference external" href="https://hexonet-python-sdk.readthedocs.io/en/latest/developmentguide.html#pull-request-pr-procedure">here</a>.</p>
156152
</div>
157153
<div class="section" id="code-of-conduct">
158154
<h2>Code of Conduct<a class="headerlink" href="#code-of-conduct" title="Permalink to this headline"></a></h2>

‎docs/_build/html/index.html‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -190,14 +190,15 @@ <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permal
190190
<ul>
191191
<li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
192192
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
193-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">1.2.5</a></li>
194-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">1.2.4</a></li>
195-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">1.2.3</a></li>
196-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">1.2.2</a></li>
197-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">1.2.1</a></li>
198-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">1.2.0</a></li>
199-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id15">1.1.0</a></li>
200-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">1.0.0</a></li>
193+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">1.2.6</a></li>
194+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">1.2.5</a></li>
195+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">1.2.4</a></li>
196+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">1.2.3</a></li>
197+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">1.2.2</a></li>
198+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">1.2.1</a></li>
199+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id15">1.2.0</a></li>
200+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id17">1.1.0</a></li>
201+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id18">1.0.0</a></li>
201202
</ul>
202203
</li>
203204
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>

0 commit comments

Comments
 (0)