Commit 46b415a3682d2eb11f87982f372c0782018d9a2d
1 parent
000f9577
Exists in
dev
update of python source code style module and html page
Showing
2 changed files
with
6 additions
and
2 deletions
Show diff stats
doc/code_style/my_package1/html/my_package1.my_module1.html
@@ -79,8 +79,10 @@ | @@ -79,8 +79,10 @@ | ||
79 | 79 | ||
80 | <section id="module-my_package1.my_module1"> | 80 | <section id="module-my_package1.my_module1"> |
81 | <span id="my-package1-my-module1-module"></span><h1>my_package1.my_module1 module<a class="headerlink" href="#module-my_package1.my_module1" title="Permalink to this headline"></a></h1> | 81 | <span id="my-package1-my-module1-module"></span><h1>my_package1.my_module1 module<a class="headerlink" href="#module-my_package1.my_module1" title="Permalink to this headline"></a></h1> |
82 | +<hr class="docutils"> | ||
82 | <blockquote> | 83 | <blockquote> |
83 | -<div><p>This file conforms to the Sphinx Napoleon syntax : | 84 | +<div><p>This MODULE is used as a reference for Python source code style & documentation</p> |
85 | +<p>This file conforms to the Sphinx Napoleon syntax : | ||
84 | <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html">https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html</a></p> | 86 | <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html">https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html</a></p> |
85 | <p>VERSION 17.02.2022</p> | 87 | <p>VERSION 17.02.2022</p> |
86 | <p>Changes :</p> | 88 | <p>Changes :</p> |
doc/code_style/my_package1/my_module1.py
@@ -2,7 +2,8 @@ | @@ -2,7 +2,8 @@ | ||
2 | 2 | ||
3 | """ | 3 | """ |
4 | ================================================================= | 4 | ================================================================= |
5 | - MODULE general Comment | 5 | + |
6 | + This MODULE is used as a reference for Python source code style & documentation | ||
6 | 7 | ||
7 | This file conforms to the Sphinx Napoleon syntax : | 8 | This file conforms to the Sphinx Napoleon syntax : |
8 | https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html | 9 | https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html |
@@ -16,6 +17,7 @@ | @@ -16,6 +17,7 @@ | ||
16 | - added new types : NamedTuple, Dataclass, Enum, TypedDict | 17 | - added new types : NamedTuple, Dataclass, Enum, TypedDict |
17 | 18 | ||
18 | - added custom and derived Exceptions | 19 | - added custom and derived Exceptions |
20 | + | ||
19 | ================================================================= | 21 | ================================================================= |
20 | """ | 22 | """ |
21 | 23 |