Main Functionalities ==================== *notebooks (ipython):* * simple forms in notebooks (see :func:`open_html_form `) * function to run a notebook offline :func:`run_notebook ` * form interacting with Python functions in a notebook, see notebook :ref:`havingaforminanotebookrst` * function :func:`add_notebook_menu ` automatically adds a menu in the notebook based on sections * method to add metadata when converting a notebook into slides :meth:`add_tag_slide ` * method to merge notebooks :meth:`merge_notebook ` * :class:`MagicCommandParser `, :class:`MagicClassWithHelpers ` to help creating magic command for IPython notebooks, the parser tries to interpret values passed to the magic commands * method :func:`nb2slides` to convert a notebook into slides *unit tests:* * folder synchronization (see :func:`pyquickhelper.synchronize_folder `) * logging (see :func:`fLOG `) * help running unit tests (see :func:`main_wrapper_tests `) *automated documentation:* * help generation including notebook conversion (see :func:`generate_help_sphinx `) * simple server to server sphinx documentation (see :func:`run_doc_server `) * function :func:`rst2html ` to convert RST into HTML * Sphinx directive :class:`BlogPostDirective ` to add a directive ``blogpost`` into the docutmention * Sphinx directive :class:`RunPythonDirective ` to generate documentation from a script * :class:`TodoExt ` for a richer ``todo`` directive * :class:`ShareNetDirective ` to add share buttons on Facebook, Linkedin, Twitter * :class:`MathDef ` defines ``mathdef`` directive, helps for documentation with mathematics *automation:* * function to create and delete jobs on `Jenkins `_, see :class:`JenkinsExt ` based on build script produced by function :func:`process_standard_options_for_setup `, Jenkisn jobs can be defined based on YAML script. See :ref:`l-ci-jenkins`. * encrypted backup, see :class:`EncryptedBackup `, the API allow to add others backup supports * folder synchronisation, see function :func:`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 :ref:`l-issues-todolist`.