import docstring into sphinx :D

This commit is contained in:
Lafrite 2015-04-23 11:46:59 +02:00
parent 0d030fa204
commit f2762bec59
5 changed files with 128 additions and 2 deletions

View File

@ -0,0 +1,7 @@
pymath
======
.. toctree::
:maxdepth: 4
pymath

View File

@ -0,0 +1,110 @@
pymath package
==============
Submodules
----------
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:
Module contents
---------------
.. automodule:: pymath
:members:
:undoc-members:
:show-inheritance:

View File

@ -19,7 +19,7 @@ import os
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('../../'))
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -104,7 +104,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'default' html_theme = 'classic'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the

View File

@ -14,6 +14,7 @@ Contents:
tutorial tutorial
construction construction
polynom polynom
code/pymath

View File

@ -177,3 +177,11 @@ Les polynômes du second degré héritent de toutes les méthodes venant de la c
* *tbl_sgn_header*: en-tête du tableau du tableau de signe écrit pour *TkzTab* * *tbl_sgn_header*: en-tête du tableau du tableau de signe écrit pour *TkzTab*
* *tbl_sgn*: ligne du tableau de signe pour *TkzTab* * *tbl_sgn*: ligne du tableau de signe pour *TkzTab*
* *tbl_variation*: ligne du tableau de variation pour *TkzTab* * *tbl_variation*: ligne du tableau de variation pour *TkzTab*
Packages
--------
Abstact_polynom
~~~~~~~~~~~~~~~
.. automodule:: pymath.abstact_polynom