**Flash Simple Documentation**
==============================

Flash - A productivity tool for handling Markdown files within PingCAP.

.. note:: 
   
   Working in progress.

.. toctree::
   :maxdepth: 7
   :caption: Contents:

Markdown Processor
==================

markdown_processor.py
---------------------
.. automodule:: pingcap.pe.flash.markdown_processor
   :members:

PowperPoint Creator
===================

ppt_creator.py
--------------
.. automodule:: pingcap.pe.flash.ppt_creator
   :members:

Education Team Tools
====================

course_keyword_seeker.py
------------------------
.. automodule:: pingcap.pe.flash.course_keyword_seeker
   :members:

cmd_create_course_keywords_table.py
-----------------------------------

* Used by script: **gen-kb-map.sh en|zh|en2zh|zh2en**

.. automodule:: pingcap.pe.flash.cmd_create_course_keywords_table
   :members:

cmd_translate_markdown_folder_zh2en.py
--------------------------------------

* Used by script: **gen-md-zh2en-by-ch.sh <chapter_no> <aws_profile> <team_tag>**

.. automodule:: pingcap.pe.flash.cmd_translate_markdown_folder_zh2en
   :members:

cmd_translate_markdown_folder_en2zh.py
--------------------------------------

* Used by script: **gen-md-en2zh-by-ch.sh <chapter_no> <aws_profile> <team_tag>**

.. automodule:: pingcap.pe.flash.cmd_translate_markdown_folder_en2zh
   :members:

Internal Utils
==============

util.py
-------
.. automodule:: pingcap.pe.flash.util
   :members:


CLI Style Converters (Markdown Folder to PowerPoint)
====================================================

cmd_pack_course.py
------------------

* Bash script wrapper: **flash-pack-course**

.. automodule:: pingcap.pe.flash.cmd_pack_course
   :members:

cmd_create_chapter_presentation_en.py
-------------------------------------

* Bash script wrapper: **flash-create-chaper-en**

.. automodule:: pingcap.pe.flash.cmd_create_chapter_presentation_en
   :members:


cmd_create_chapter_presentation_en2zh.py
----------------------------------------

* Bash script wrapper: **flash-create-chaper-en2zh**

.. automodule:: pingcap.pe.flash.cmd_create_chapter_presentation_en2zh
   :members:

cmd_create_chapter_presentation_zh.py
-------------------------------------

* Bash script wrapper: **flash-create-chaper-zh**

.. automodule:: pingcap.pe.flash.cmd_create_chapter_presentation_zh
   :members:

cmd_create_chapter_presentation_zh2en.py
----------------------------------------

* Bash script wrapper: **flash-create-chaper-zh2en**

.. automodule:: pingcap.pe.flash.cmd_create_chapter_presentation_zh2en
   :members:

cmd_create_chapter_presentation.py
----------------------------------

* Bash script wrapper: **flash-create-chaper**

.. automodule:: pingcap.pe.flash.cmd_create_chapter_presentation
   :members:

CLI Style Converters (PowerPoint to Markdown Folder)
====================================================

* Bash script wrapper: **flash-inspect-ppt.sh**

cmd_inspect_ppt.py
------------------
.. automodule:: pingcap.pe.flash.cmd_inspect_ppt
   :members:

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`