From 602fd12b1ecfe9676a0d2365bf21fae04e8ff6aa Mon Sep 17 00:00:00 2001 From: Benjamin Bertrand Date: Tue, 12 Jan 2016 11:30:25 +0300 Subject: [PATCH] add code documentation --- documentation/source/code/pymath.calculus.rst | 117 ++++++++++++++++++ .../source/code/pymath.calculus.test.rst | 102 +++++++++++++++ documentation/source/code/pymath.rst | 102 +-------------- documentation/source/code/pymath.stat.rst | 46 +++++++ 4 files changed, 270 insertions(+), 97 deletions(-) create mode 100644 documentation/source/code/pymath.calculus.rst create mode 100644 documentation/source/code/pymath.calculus.test.rst create mode 100644 documentation/source/code/pymath.stat.rst diff --git a/documentation/source/code/pymath.calculus.rst b/documentation/source/code/pymath.calculus.rst new file mode 100644 index 0000000..575d2a4 --- /dev/null +++ b/documentation/source/code/pymath.calculus.rst @@ -0,0 +1,117 @@ +pymath.calculus package +======================= + +Subpackages +----------- + +.. toctree:: + + pymath.calculus.test + +Submodules +---------- + +pymath.calculus.abstract_polynom module +--------------------------------------- + +.. automodule:: pymath.calculus.abstract_polynom + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.arithmetic module +--------------------------------- + +.. automodule:: pymath.calculus.arithmetic + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.explicable module +--------------------------------- + +.. automodule:: pymath.calculus.explicable + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.expression module +--------------------------------- + +.. automodule:: pymath.calculus.expression + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.fraction module +------------------------------- + +.. automodule:: pymath.calculus.fraction + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.generic module +------------------------------ + +.. automodule:: pymath.calculus.generic + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.operator module +------------------------------- + +.. automodule:: pymath.calculus.operator + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.polynom module +------------------------------ + +.. automodule:: pymath.calculus.polynom + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.polynomDeg2 module +---------------------------------- + +.. automodule:: pymath.calculus.polynomDeg2 + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.random_expression module +---------------------------------------- + +.. automodule:: pymath.calculus.random_expression + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.render module +----------------------------- + +.. automodule:: pymath.calculus.render + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.str2tokens module +--------------------------------- + +.. automodule:: pymath.calculus.str2tokens + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pymath.calculus + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/source/code/pymath.calculus.test.rst b/documentation/source/code/pymath.calculus.test.rst new file mode 100644 index 0000000..c4576dc --- /dev/null +++ b/documentation/source/code/pymath.calculus.test.rst @@ -0,0 +1,102 @@ +pymath.calculus.test package +============================ + +Submodules +---------- + +pymath.calculus.test.mass_test module +------------------------------------- + +.. automodule:: pymath.calculus.test.mass_test + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_arithmetic module +------------------------------------------- + +.. automodule:: pymath.calculus.test.test_arithmetic + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_expression module +------------------------------------------- + +.. automodule:: pymath.calculus.test.test_expression + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_fraction module +----------------------------------------- + +.. automodule:: pymath.calculus.test.test_fraction + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_generic module +---------------------------------------- + +.. automodule:: pymath.calculus.test.test_generic + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_operator module +----------------------------------------- + +.. automodule:: pymath.calculus.test.test_operator + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_polynom module +---------------------------------------- + +.. automodule:: pymath.calculus.test.test_polynom + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_polynomDeg2 module +-------------------------------------------- + +.. automodule:: pymath.calculus.test.test_polynomDeg2 + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_random_expression module +-------------------------------------------------- + +.. automodule:: pymath.calculus.test.test_random_expression + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_render module +--------------------------------------- + +.. automodule:: pymath.calculus.test.test_render + :members: + :undoc-members: + :show-inheritance: + +pymath.calculus.test.test_str2tokens module +------------------------------------------- + +.. automodule:: pymath.calculus.test.test_str2tokens + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pymath.calculus.test + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/source/code/pymath.rst b/documentation/source/code/pymath.rst index 27aaced..a73501e 100644 --- a/documentation/source/code/pymath.rst +++ b/documentation/source/code/pymath.rst @@ -1,105 +1,13 @@ pymath package ============== -Submodules ----------- +Subpackages +----------- -pymath.abstract_polynom module ------------------------------- - -.. automodule:: pymath.abstract_polynom - :members: - :undoc-members: - :show-inheritance: - -pymath.arithmetic module ------------------------- - -.. automodule:: pymath.arithmetic - :members: - :undoc-members: - :show-inheritance: - -pymath.explicable module ------------------------- - -.. automodule:: pymath.explicable - :members: - :undoc-members: - :show-inheritance: - -pymath.expression module ------------------------- - -.. automodule:: pymath.expression - :members: - :undoc-members: - :show-inheritance: - -pymath.fraction module ----------------------- - -.. automodule:: pymath.fraction - :members: - :undoc-members: - :show-inheritance: - -pymath.generic module ---------------------- - -.. automodule:: pymath.generic - :members: - :undoc-members: - :show-inheritance: - -pymath.operator module ----------------------- - -.. automodule:: pymath.operator - :members: - :undoc-members: - :show-inheritance: - -pymath.polynom module ---------------------- - -.. automodule:: pymath.polynom - :members: - :undoc-members: - :show-inheritance: - -pymath.polynomDeg2 module -------------------------- - -.. automodule:: pymath.polynomDeg2 - :members: - :undoc-members: - :show-inheritance: - -pymath.random_expression module -------------------------------- - -.. automodule:: pymath.random_expression - :members: - :undoc-members: - :show-inheritance: - -pymath.render module --------------------- - -.. automodule:: pymath.render - :members: - :undoc-members: - :show-inheritance: - -pymath.str2tokens module ------------------------- - -.. automodule:: pymath.str2tokens - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + pymath.calculus + pymath.stat Module contents --------------- diff --git a/documentation/source/code/pymath.stat.rst b/documentation/source/code/pymath.stat.rst new file mode 100644 index 0000000..644d0e2 --- /dev/null +++ b/documentation/source/code/pymath.stat.rst @@ -0,0 +1,46 @@ +pymath.stat package +=================== + +Submodules +---------- + +pymath.stat.dataset module +-------------------------- + +.. automodule:: pymath.stat.dataset + :members: + :undoc-members: + :show-inheritance: + +pymath.stat.number_tools module +------------------------------- + +.. automodule:: pymath.stat.number_tools + :members: + :undoc-members: + :show-inheritance: + +pymath.stat.random_generator module +----------------------------------- + +.. automodule:: pymath.stat.random_generator + :members: + :undoc-members: + :show-inheritance: + +pymath.stat.weightedDataset module +---------------------------------- + +.. automodule:: pymath.stat.weightedDataset + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pymath.stat + :members: + :undoc-members: + :show-inheritance: