Main Functionalities

notebooks (ipython):

• simple forms in notebooks (see open_html_form)

• function to run a notebook offline run_notebook

• form interacting with Python functions in a notebook, see notebook Having a form in a notebook

• function add_notebook_menu automatically adds a menu in the notebook based on sections

• method to add metadata when converting a notebook into slides add_tag_slide

• method to merge notebooks merge_notebook

• MagicCommandParser, MagicClassWithHelpers to help creating magic command for IPython notebooks, the parser tries to interpret values passed to the magic commands

• method nb2slides to convert a notebook into slides

unit tests:

• folder synchronization (see pyquickhelper.synchronize_folder)

• logging (see fLOG)

• help running unit tests (see main_wrapper_tests)

automated documentation:

• help generation including notebook conversion (see generate_help_sphinx)

• simple server to server sphinx documentation (see run_doc_server)

• function rst2html to convert RST into HTML

• Sphinx directive BlogPostDirective to add a directive blogpost into the docutmention

• Sphinx directive RunPythonDirective to generate documentation from a script

• TodoExt for a richer todo directive

• ShareNetDirective to add share buttons on Facebook, Linkedin, Twitter

• MathDef defines mathdef directive, helps for documentation with mathematics

automation:

• function to create and delete jobs on Jenkins, see JenkinsExt based on build script produced by function process_standard_options_for_setup, Jenkisn jobs can be defined based on YAML script. See Continuous Integration.

• encrypted backup, see EncryptedBackup, the API allow to add others backup supports

• folder synchronisation, see function synchronize_folder

encryption

The module proposes two commands encrypt, decrypt, encrypt_file, decrypt_file:

usage: encrypt [-h] source dest password
usage: decrypt [-h] source dest password
usage: encrypt_file [-h] source dest password
usage: decrypt_file [-h] source dest password

Many functionalities about automated documentation assume the current processed documentation follows the same design as this module. Future enhancements are covered by Issues.