pbrod/numdifftools

View on GitHub
docs/index.rst

Summary

Maintainability
Test Coverage
Welcome to the numdifftools' documentation!
===========================================
.. only:: html

    |pkg_img| |tests_img| |docs_img| |health_img| |coverage_img| |versions_img| |downloads_img|


This is the documentation of **Numdifftools** version |release| released |today|.

Bleeding edge available at: https://github.com/pbrod/numdifftools.

Official releases are available at: http://pypi.python.org/pypi/Numdifftools.


.. toctree::
    :maxdepth: 3
    :numbered:
    :includehidden:
    :caption: Contents:


    intro/index.rst
    tutorials/index.rst
    how-to/index.rst
    topics/index.rst
    reference/index.rst


.. only:: html

    .. toctree::
        :maxdepth: 3

        appendix/changelog.rst
        appendix/authors.rst
        appendix/license.rst
        appendix/acknowledgement.rst
        appendix/index.rst
        appendix/zreferences.rst

    .. |pkg_img| image:: https://badge.fury.io/py/numdifftools.svg
        :target: https://badge.fury.io/py/numdifftools

    .. |tests_img| image:: https://github.com/pbrod/numdifftools/actions/workflows/test.yml/badge.svg
       :target: https://github.com/pbrod/numdifftools/actions/workflows/test.yml

    .. |health_img| image:: https://api.codeclimate.com/v1/badges/698996d1ec94028ec223/maintainability.svg
        :target: https://codeclimate.com/github/pbrod/numdifftools/maintainability
        :alt: Maintainability

    .. |coverage_img| image:: https://api.codeclimate.com/v1/badges/698996d1ec94028ec223/test_coverage.svg
        :target: https://codeclimate.com/github/pbrod/numdifftools/test_coverage
        :alt: Test Coverage

    .. |versions_img| image:: https://img.shields.io/pypi/pyversions/numdifftools.svg
        :target: https://github.com/pbrod/numdifftools

    .. |downloads_img| image:: https://img.shields.io/pypi/dm/numdifftools.svg
        :alt: PyPI - Downloads

    .. |docs_img| image:: https://readthedocs.org/projects/numdifftools/badge/?svg=true
        :target: http://numdifftools.readthedocs.org/en/stable/
        :alt: Documentation