.. YaPyCon documentation master file, created by
   sphinx-quickstart on Tue Nov 30 10:09:21 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to YaPyCon's documentation!
===================================

YaPyCon embeds a Python console in YASARA, *"...a molecular-graphics, -modeling and -simulation
program for Windows, Linux, MacOS and Android"* thereby:

1. Enabling rapid prototyping of YASARA scripts
2. Offering common "shell" functionality such as:

   * Code auto-completion
   * Inline code documentation
   * Tighter integration with ``matplotlib``

4. Improving and expanding certain aspects of YASARA's Python functionality.


.. thumbnail:: resources/figures/fig_main_yapycon.png



.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   installation
   functionality
   examples
   api

   motivation
   devnotes
   current_todos

   moddoc

Indices and tables
==================

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