Skip to content

Commit b860f04

Browse files
pawamoypawamoy
committed
Deployed c2924ed with MkDocs version: 1.1
1 parent a0b24f8 commit b860f04

33 files changed

Lines changed: 1658 additions & 478 deletions

File tree

‎changelog/index.html‎

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -371,13 +371,32 @@
371371
<label class="md-nav__title" for="__toc">Table of contents</label>
372372
<ul class="md-nav__list" data-md-scrollfix="">
373373
<li class="md-nav__item">
374+
<a class="md-nav__link" href="#v030-2020-04-10">
375+
v0.3.0 - 2020-04-10
376+
</a>
377+
<nav class="md-nav">
378+
<ul class="md-nav__list">
379+
<li class="md-nav__item">
380+
<a class="md-nav__link" href="#bug-fixes">
381+
Bug Fixes
382+
</a>
383+
</li>
384+
<li class="md-nav__item">
385+
<a class="md-nav__link" href="#features">
386+
Features
387+
</a>
388+
</li>
389+
</ul>
390+
</nav>
391+
</li>
392+
<li class="md-nav__item">
374393
<a class="md-nav__link" href="#v021-2020-04-07">
375394
v0.2.1 - 2020-04-07
376395
</a>
377396
<nav class="md-nav">
378397
<ul class="md-nav__list">
379398
<li class="md-nav__item">
380-
<a class="md-nav__link" href="#bug-fixes">
399+
<a class="md-nav__link" href="#bug-fixes_1">
381400
Bug Fixes
382401
</a>
383402
</li>
@@ -465,13 +484,32 @@
465484
<label class="md-nav__title" for="__toc">Table of contents</label>
466485
<ul class="md-nav__list" data-md-scrollfix="">
467486
<li class="md-nav__item">
487+
<a class="md-nav__link" href="#v030-2020-04-10">
488+
v0.3.0 - 2020-04-10
489+
</a>
490+
<nav class="md-nav">
491+
<ul class="md-nav__list">
492+
<li class="md-nav__item">
493+
<a class="md-nav__link" href="#bug-fixes">
494+
Bug Fixes
495+
</a>
496+
</li>
497+
<li class="md-nav__item">
498+
<a class="md-nav__link" href="#features">
499+
Features
500+
</a>
501+
</li>
502+
</ul>
503+
</nav>
504+
</li>
505+
<li class="md-nav__item">
468506
<a class="md-nav__link" href="#v021-2020-04-07">
469507
v0.2.1 - 2020-04-07
470508
</a>
471509
<nav class="md-nav">
472510
<ul class="md-nav__list">
473511
<li class="md-nav__item">
474-
<a class="md-nav__link" href="#bug-fixes">
512+
<a class="md-nav__link" href="#bug-fixes_1">
475513
Bug Fixes
476514
</a>
477515
</li>
@@ -551,9 +589,19 @@ <h1 id="changelog">Changelog</h1>
551589
<p>All notable changes to this project will be documented in this file.</p>
552590
<p>The format is based on <a href="http://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>
553591
and this project adheres to <a href="http://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
592+
<h2 id="v030-2020-04-10"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/v0.3.0">v0.3.0</a> - 2020-04-10</h2>
593+
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/v0.2.1...v0.3.0">Compare with v0.2.1</a></small></p>
594+
<h3 id="bug-fixes">Bug Fixes</h3>
595+
<ul>
596+
<li>Fix parsing of <code>*args</code> and <code>**kwargs</code> (<a href="https://github.com/pawamoy/pytkdocs/commit/b81c93eef2435f2ed1d70b4d7c3946caa564c59e">b81c93e</a> by adrienhenry). Related issues/PRs: <a href="https://github.com/pawamoy/pytkdocs/issues/20">#20</a>, <a href="https://github.com/pawamoy/pytkdocs/issues/21">#21</a></li>
597+
</ul>
598+
<h3 id="features">Features</h3>
599+
<ul>
600+
<li>Support different indentations and complex markup in docstrings sections (<a href="https://github.com/pawamoy/pytkdocs/commit/2f53082dbd2bcb72423d4aff0cb3bf4319476be7">2f53082</a> by Timothée Mazzucotelli). Related issues/PRs: <a href="https://github.com/pawamoy/pytkdocs/issues/17">#17</a></li>
601+
</ul>
554602
<h2 id="v021-2020-04-07"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/v0.2.1">v0.2.1</a> - 2020-04-07</h2>
555603
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/v0.2.0...v0.2.1">Compare with v0.2.0</a></small></p>
556-
<h3 id="bug-fixes">Bug Fixes</h3>
604+
<h3 id="bug-fixes_1">Bug Fixes</h3>
557605
<ul>
558606
<li>Fix forward refs replacement for python &gt; 3.6 (<a href="https://github.com/pawamoy/pytkdocs/commit/6a90aca346209fe2a4e3eec6bfb45f353bce679f">6a90aca</a> by Timothée Mazzucotelli).</li>
559607
<li>Handle exception parsing error (<a href="https://github.com/pawamoy/pytkdocs/commit/d6561f86362e7a9d8c45471f1d6eb5deffd5e0c8">d6561f8</a> by Timothée Mazzucotelli). Related issues/PRs: <a href="https://github.com/pawamoy/pytkdocs/issues/16">#16</a></li>

‎contributing/index.html‎

Lines changed: 94 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -224,8 +224,28 @@
224224
<label class="md-nav__title" for="__toc">Table of contents</label>
225225
<ul class="md-nav__list" data-md-scrollfix="">
226226
<li class="md-nav__item">
227-
<a class="md-nav__link" href="#bug-fixes-new-features-and-documentation">
228-
Bug fixes, new features and documentation
227+
<a class="md-nav__link" href="#setup">
228+
Setup
229+
</a>
230+
</li>
231+
<li class="md-nav__item">
232+
<a class="md-nav__link" href="#new-feature-or-bug-fix">
233+
New feature or bug fix
234+
</a>
235+
</li>
236+
<li class="md-nav__item">
237+
<a class="md-nav__link" href="#running-tests">
238+
Running tests
239+
</a>
240+
</li>
241+
<li class="md-nav__item">
242+
<a class="md-nav__link" href="#commits-messages">
243+
Commits messages
244+
</a>
245+
</li>
246+
<li class="md-nav__item">
247+
<a class="md-nav__link" href="#pull-requests">
248+
Pull Requests
229249
</a>
230250
</li>
231251
</ul>
@@ -395,8 +415,28 @@
395415
<label class="md-nav__title" for="__toc">Table of contents</label>
396416
<ul class="md-nav__list" data-md-scrollfix="">
397417
<li class="md-nav__item">
398-
<a class="md-nav__link" href="#bug-fixes-new-features-and-documentation">
399-
Bug fixes, new features and documentation
418+
<a class="md-nav__link" href="#setup">
419+
Setup
420+
</a>
421+
</li>
422+
<li class="md-nav__item">
423+
<a class="md-nav__link" href="#new-feature-or-bug-fix">
424+
New feature or bug fix
425+
</a>
426+
</li>
427+
<li class="md-nav__item">
428+
<a class="md-nav__link" href="#running-tests">
429+
Running tests
430+
</a>
431+
</li>
432+
<li class="md-nav__item">
433+
<a class="md-nav__link" href="#commits-messages">
434+
Commits messages
435+
</a>
436+
</li>
437+
<li class="md-nav__item">
438+
<a class="md-nav__link" href="#pull-requests">
439+
Pull Requests
400440
</a>
401441
</li>
402442
</ul>
@@ -413,37 +453,72 @@ <h1 id="contributing">Contributing</h1>
413453
<p>For bug reports, feature requests, and feedback,
414454
simply create a new <a href="https://github.com/pawamoy/pytkdocs/issues/new">issue</a>.
415455
Try to be as descriptive as possible.</p>
416-
<h3 id="bug-fixes-new-features-and-documentation">Bug fixes, new features and documentation</h3>
456+
<h2 id="setup">Setup</h2>
417457
<p>This project is developed using <a href="https://github.com/sdispater/poetry"><code>poetry</code></a>.
418458
Follow the recommended installation method:</p>
419-
<div class="codehilite"><pre><span></span><code>curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py <span class="p">|</span> python
459+
<div class="highlight"><pre><span></span><code>curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py <span class="p">|</span> python
460+
</code></pre></div>
461+
<p>...or install it with <a href="https://github.com/pipxproject/pipx"><code>pipx</code></a>:</p>
462+
<div class="highlight"><pre><span></span><code>pipx install poetry
420463
</code></pre></div>
421464
<p>Then follow these instructions:</p>
422465
<ol>
423466
<li>Fork the repository <a href="https://github.com/pawamoy/pytkdocs">on github.com</a>;</li>
424467
<li>Clone it on your machine;</li>
425-
<li>Go into the directory, and run <code>poetry install</code> to setup the development environment;</li>
468+
<li>Go into the directory, and run <code>poetry install</code> to install all the dependencies into a new virtualenv.</li>
469+
</ol>
470+
<h2 id="new-feature-or-bug-fix">New feature or bug fix</h2>
471+
<ol>
426472
<li>Create a new branch with <code>git checkout -b bug-fix-or-feature-name</code>;</li>
427473
<li>Code!</li>
428-
<li><strong>Write tests. Run them all.</strong> The commands to run the tests are:
429-
<div class="codehilite"><pre><span></span><code>poetry run pytest <span class="c1"># to run all tests sequentially</span>
474+
<li><strong>Write tests. Run them all.</strong></li>
475+
</ol>
476+
<h2 id="running-tests">Running tests</h2>
477+
<p>The command to run the tests is:</p>
478+
<div class="highlight"><pre><span></span><code>make test
479+
</code></pre></div>
480+
<p>For more flexibility:</p>
481+
<div class="highlight"><pre><span></span><code>poetry run pytest <span class="c1"># to run all tests sequentially</span>
430482
poetry run pytest -v <span class="c1"># to print one test per line</span>
431483
poetry run pytest -n <span class="m">4</span> <span class="c1"># to run tests in parallel (4 workers)</span>
432484
poetry run pytest tests/test_api.py <span class="c1"># to run tests in a specific file</span>
433-
</code></pre></div></li>
434-
</ol>
485+
</code></pre></div>
435486
<p><code>pytest</code> provides the <code>-k</code> option to select tests based on their names:</p>
436-
<div class="codehilite"><pre><span></span><code>poetry run pytest -k <span class="s2">"api and remove"</span>
487+
<div class="highlight"><pre><span></span><code>poetry run pytest -k <span class="s2">"api and remove"</span>
437488
poetry run pytest -k <span class="s2">"utils or stats"</span>
438489
</code></pre></div>
439490
<p>See the <a href="https://docs.pytest.org/en/latest/example/markers.html#using-k-expr-to-select-tests-based-on-their-name">documentation for the <code>-k</code> option</a> for more examples.</p>
440-
<p>A <a href="Makefile">Makefile</a> is available for convenience: <code>make test</code>.
441-
1. When the tests pass, commit
442-
(make sure to have atomic commits and contextual commit messages!
443-
<a href="https://github.com/pawamoy/pytkdocs/compare">Check out this awesome blog post by Chris Beams for more information.</a>)
444-
1. Push;
445-
1. ...and finally, create a new <a href="http://chris.beams.io/posts/git-commit/">pull/merge request</a>!
446-
Make sure to follow the guidelines.</p>
491+
<h2 id="commits-messages">Commits messages</h2>
492+
<p>Make sure to have atomic commits and contextual commit messages!
493+
<a href="http://chris.beams.io/posts/git-commit/">Check out this blog post by Chris Beams for more information</a>.</p>
494+
<p>Commits messages must follow the <a href="https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message">Angular style</a>:</p>
495+
<div class="highlight"><pre><span></span><code>&lt;type&gt;[(scope)]: Subject
496+
497+
[Body]
498+
</code></pre></div>
499+
<p>Scope and body are optional. Type can be:</p>
500+
<ul>
501+
<li><code>build</code>: About packaging, building wheels, etc.</li>
502+
<li><code>chore</code>: About packaging or repo/files management.</li>
503+
<li><code>ci</code>: About Continuous Integration.</li>
504+
<li><code>docs</code>: About documentation.</li>
505+
<li><code>feat</code>: New feature.</li>
506+
<li><code>fix</code>: Bug fix.</li>
507+
<li><code>perf</code>: About performance.</li>
508+
<li><code>refactor</code>: Changes which are not features nor bug fixes.</li>
509+
<li><code>revert</code>: When reverting a commit.</li>
510+
<li><code>style</code>: A change in code style/format.</li>
511+
<li><code>tests</code>: About tests.</li>
512+
</ul>
513+
<p>Subject (and body) must be valid Markdown. If you write a body, please add issues references at the end:</p>
514+
<div class="highlight"><pre><span></span><code>Body.
515+
516+
References: #10, #11.
517+
Fixes #15.
518+
</code></pre></div>
519+
<h2 id="pull-requests">Pull Requests</h2>
520+
<p>Push your code, and finally create a new <a href="https://github.com/pawamoy/pytkdocs/compare">pull request</a>.
521+
Make sure to follow the guidelines.</p>
447522
</article>
448523
</div>
449524
</div>

‎developers/test_suite/__init__/index.html‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@
3737
<input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
3838
<input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
3939
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
40+
<a class="md-skip" href="#tests.__init__" tabindex="0">
41+
Skip to content
42+
</a>
4043
<header class="md-header" data-md-component="header">
4144
<nav class="md-header-nav md-grid">
4245
<div class="md-flex">
@@ -236,9 +239,37 @@
236239
<ul class="md-nav__list" data-md-scrollfix="">
237240
<li class="md-nav__item md-nav__item--active">
238241
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" id="__toc" type="checkbox"/>
242+
<label class="md-nav__link md-nav__link--active" for="__toc">
243+
__init__.py
244+
</label>
239245
<a class="md-nav__link md-nav__link--active" href="./" title="__init__.py">
240246
__init__.py
241247
</a>
248+
<nav class="md-nav md-nav--secondary">
249+
<label class="md-nav__title" for="__toc">Table of contents</label>
250+
<ul class="md-nav__list" data-md-scrollfix="">
251+
<li class="md-nav__item">
252+
<a class="md-nav__link" href="#tests.__init__">
253+
tests.__init__
254+
</a>
255+
</li>
256+
<li class="md-nav__item">
257+
<a class="md-nav__link" href="#tests.__init__.FIXTURES_DIR">
258+
FIXTURES_DIR
259+
</a>
260+
</li>
261+
<li class="md-nav__item">
262+
<a class="md-nav__link" href="#tests.__init__.TESTS_DIR">
263+
TESTS_DIR
264+
</a>
265+
</li>
266+
<li class="md-nav__item">
267+
<a class="md-nav__link" href="#tests.__init__.TMP_DIR">
268+
TMP_DIR
269+
</a>
270+
</li>
271+
</ul>
272+
</nav>
242273
</li>
243274
<li class="md-nav__item">
244275
<a class="md-nav__link" href="../conftest/" title="conftest.py">
@@ -372,10 +403,77 @@
372403
</div>
373404
</div>
374405
</div>
406+
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
407+
<div class="md-sidebar__scrollwrap">
408+
<div class="md-sidebar__inner">
409+
<nav class="md-nav md-nav--secondary">
410+
<label class="md-nav__title" for="__toc">Table of contents</label>
411+
<ul class="md-nav__list" data-md-scrollfix="">
412+
<li class="md-nav__item">
413+
<a class="md-nav__link" href="#tests.__init__">
414+
tests.__init__
415+
</a>
416+
</li>
417+
<li class="md-nav__item">
418+
<a class="md-nav__link" href="#tests.__init__.FIXTURES_DIR">
419+
FIXTURES_DIR
420+
</a>
421+
</li>
422+
<li class="md-nav__item">
423+
<a class="md-nav__link" href="#tests.__init__.TESTS_DIR">
424+
TESTS_DIR
425+
</a>
426+
</li>
427+
<li class="md-nav__item">
428+
<a class="md-nav__link" href="#tests.__init__.TMP_DIR">
429+
TMP_DIR
430+
</a>
431+
</li>
432+
</ul>
433+
</nav>
434+
</div>
435+
</div>
436+
</div>
375437
<div class="md-content">
376438
<article class="md-content__inner md-typeset">
377439
<a class="md-icon md-content__icon" href="https://github.com/pawamoy/pytkdocs/edit/master/docs/developers/test_suite/__init__.md" title="Edit this page"></a>
378440
<h1>__init__.py</h1>
441+
<div class="doc doc-object doc-module">
442+
<h2 class="hidden-toc" href="#tests.__init__" id="tests.__init__" style="visibility: hidden; width: 0; height: 0;">
443+
</h2>
444+
<div class="doc doc-contents first">
445+
<p>In this module we simply define some path constants.</p>
446+
<div class="doc doc-children">
447+
<div class="doc doc-object doc-attribute">
448+
<h2 class="doc doc-heading" id="tests.__init__.FIXTURES_DIR">
449+
<code class="highlight">
450+
FIXTURES_DIR: <span class="n">Path</span> </code>
451+
</h2>
452+
<div class="doc doc-contents">
453+
<p>The tests/fixtures directory path object.</p>
454+
</div>
455+
</div>
456+
<div class="doc doc-object doc-attribute">
457+
<h2 class="doc doc-heading" id="tests.__init__.TESTS_DIR">
458+
<code class="highlight">
459+
TESTS_DIR: <span class="n">Path</span> </code>
460+
</h2>
461+
<div class="doc doc-contents">
462+
<p>The tests directory path object.</p>
463+
</div>
464+
</div>
465+
<div class="doc doc-object doc-attribute">
466+
<h2 class="doc doc-heading" id="tests.__init__.TMP_DIR">
467+
<code class="highlight">
468+
TMP_DIR: <span class="n">Path</span> </code>
469+
</h2>
470+
<div class="doc doc-contents">
471+
<p>The tests/tmp directory path object.</p>
472+
</div>
473+
</div>
474+
</div>
475+
</div>
476+
</div>
379477
</article>
380478
</div>
381479
</div>

0 commit comments

Comments
 (0)