python3_module_template
=======================
.. only:: html
.. image:: https://travis-ci.com/sdpython/python3_module_template.svg?branch=master
:target: https://app.travis-ci.com/github/sdpython/python3_module_template
:alt: Build status
.. image:: https://ci.appveyor.com/api/projects/status/8yv4brsckay4374a?svg=true
:target: https://ci.appveyor.com/project/sdpython/python3-module-template
:alt: Build Status Windows
.. image:: https://circleci.com/gh/sdpython/python3_module_template/tree/master.svg?style=svg
:target: https://circleci.com/gh/sdpython/python3_module_template/tree/master
.. image:: https://dev.azure.com/xavierdupre3/pyquickhelper/_apis/build/status/sdpython.python3_module_template
:target: https://dev.azure.com/xavierdupre3/python3_module_template/
.. image:: https://badge.fury.io/py/python3_module_template.svg
:target: http://badge.fury.io/py/python3_module_template
.. image:: http://img.shields.io/github/issues/sdpython/python3_module_template.png
:alt: GitHub Issues
:target: https://github.com/sdpython/python3_module_template/issues
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: MIT License
:target: http://opensource.org/licenses/MIT
.. image:: https://codecov.io/github/sdpython/python3_module_template/coverage.svg?branch=master
:target: https://codecov.io/github/sdpython/python3_module_template?branch=master
.. image:: nbcov.png
:target: http://www.xavierdupre.fr/app/python3_module_template/helpsphinx/all_notebooks_coverage.html
:alt: Notebook Coverage
.. image:: https://img.shields.io/github/repo-size/sdpython/python3_module_template
:target: https://github.com/sdpython/python3_module_template/
:alt: size
**Links:** `github `_,
`documentation `_,
`travis `_,
:ref:`l-README`,
:ref:`blog `,
:ref:`l-issues-todolist`,
:ref:`l-completed-todolist`
What is it?
-----------
This project is a template to start a new project. See :ref:`l-README`.
See some examples:
* **Example**
* example: :class:`myclass `
An equation: :math:`\sum_i x_i^2`.
Installation
------------
::
pip install python3_module_template
To avoid the dependencies::
pip install python3_module_template --no-deps
Documentation
-------------
.. toctree::
:maxdepth: 1
api/index
i_ex
i_faq
i_nb
issues_todoextlist
completed_todoextlist
Galleries
---------
.. toctree::
:maxdepth: 2
gallery1/index
gallery2/index
all_notebooks
blog/blogindex
Navigation
----------
.. toctree::
:maxdepth: 1
indexmenu
HISTORY
.. toctree::
:hidden:
blog/index_blog
+----------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`l-modules` | :ref:`l-functions` | :ref:`l-classes` | :ref:`l-methods` | :ref:`l-staticmethods` | :ref:`l-properties` |
+----------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`modindex` | :ref:`l-EX2` | :ref:`search` | :ref:`l-license` | :ref:`l-changes` | :ref:`l-README` |
+----------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`genindex` | :ref:`l-FAQ2` | :ref:`l-notebooks` | :ref:`ext-tohelp` | :ref:`l-statcode` | `Unit Test Coverage `_ |
+----------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+