:orphan:

Tutorial
========

Below is list of (ordered) tutorials on how to use the module.


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a basic example for generating a simple program with npdoc_cli.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_e01_program_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_e01_program.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating a Program</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This tutorial goes over how npdoc-cli parses function signatures affect the command line interface.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_e02_typing_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_e02_typing.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Function Signatures</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This tutorial goes over how to use the doc-strings to further customize your CLI.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_e03_docstrings_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_e03_docstrings.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Doc Strings</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This module explains how to organize a CLI into different commands and subcommands.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_e04_commands_subcommands_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_e04_commands_subcommands.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Commands and Subcommands</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This module explains how naming rules can be applied to a CLI.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_e05_naming_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_plot_e05_naming.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Naming</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_e01_program
   /auto_examples/plot_e02_typing
   /auto_examples/plot_e03_docstrings
   /auto_examples/plot_e04_commands_subcommands
   /auto_examples/plot_e05_naming


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_