.. image:: https://github.com/sdpython/pyquickhelper/blob/master/_doc/sphinxdoc/source/_static/project_ico.png?raw=true :target: https://github.com/sdpython/pyquickhelper/ .. _l-README: pyquickhelper: automation of many things ======================================== .. image:: https://travis-ci.com/sdpython/pyquickhelper.svg?branch=master :target: https://app.travis-ci.com/github/sdpython/pyquickhelper/ :alt: Build status .. image:: https://ci.appveyor.com/api/projects/status/t2g9olcgqgdvqq3l?svg=true :target: https://ci.appveyor.com/project/sdpython/pyquickhelper :alt: Build Status Windows .. image:: https://circleci.com/gh/sdpython/pyquickhelper/tree/master.svg?style=svg :target: https://circleci.com/gh/sdpython/pyquickhelper/tree/master .. image:: https://dev.azure.com/xavierdupre3/pyquickhelper/_apis/build/status/sdpython.pyquickhelper :target: https://dev.azure.com/xavierdupre3/pyquickhelper/ .. image:: https://badge.fury.io/py/pyquickhelper.svg :target: https://pypi.org/project/pyquickhelper/ .. 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/pyquickhelper/coverage.svg?branch=master :target: https://codecov.io/github/sdpython/pyquickhelper?branch=master .. image:: http://img.shields.io/github/issues/sdpython/pyquickhelper.png :alt: GitHub Issues :target: https://github.com/sdpython/pyquickhelper/issues .. image:: https://app.codacy.com/project/badge/Grade/9d73a6712fb24e2fa404b3e33c6201ac :target: https://www.codacy.com/gh/sdpython/pyquickhelper/dashboard?utm_source=github.com&utm_medium=referral&utm_content=sdpython/pyquickhelper&utm_campaign=Badge_Grade :alt: Codacy Badge .. image:: http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/_images/nbcov.png :target: http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/all_notebooks_coverage.html :alt: Notebook Coverage .. image:: https://pepy.tech/badge/pyquickhelper/month :target: https://pepy.tech/project/pyquickhelper/month :alt: Downloads .. image:: https://img.shields.io/github/forks/sdpython/pyquickhelper.svg :target: https://github.com/sdpython/pyquickhelper/ :alt: Forks .. image:: https://img.shields.io/github/stars/sdpython/pyquickhelper.svg :target: https://github.com/sdpython/pyquickhelper/ :alt: Stars .. image:: https://img.shields.io/github/repo-size/sdpython/pyquickhelper :target: https://github.com/sdpython/pyquickhelper/ :alt: size `pyquickhelper `_ is used to automate the release of the documentation such as automating *Jenkins*, converting notebooks into many formats, extending *Sphinx* with custom extensions... It assumes the project is organized on the same template as this one. Functionalities --------------- * simple forms in notebooks * help generation including notebook conversion * folder synchronization * logging * help running unit tests * simple server to server sphinx documentation * file compression, zip, gzip, 7z * helpers for ipython notebooks (upgrade, offline run) * parser to quickly add a magic command in a notebook * Sphinx directives to integrate a blogpost in the documentation * mechanism to add forms in notebooks Design ------ This project contains the following folders: * a source folder: *src* * a unit test folder: *_unittests*, go to this folder and run *run_unittests.py* * a folder: *_doc*, it will contain the documentation, a subfolder *_doc/sphinxdox/source/blog* contains blog post to communicate on the module * a file *setup.py* to build and to install the module, if the source were retrieve from GitHub, the script can also be called with the following extra options (*python setup.py