.. pyXsurf documentation master file, created by
    sphinx-quickstart on Mon Mar 14 19:25:52 2022.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.

.. |wip2| image:: resources/wip.png
    :height: 25px

Welcome to pyXsurf's documentation!
===================================

pyXSurf is a Python library to perform common operations on data defined over  2D or 1D coordinates.
It also includes a set of convenience functions and other tools for X-ray optics. 

.. .. image:: resources/wip.png   #this creates a large icon

.. note that referring to tags in readme_link refers to sections of the page generated from the readme_link.rst content
    but at same time adds the possibility of adding content at the end of the linked content.

🛠️ Work in Progress! 
Thanks for your interest to this project. We're currently making significant updates. 
Please check back soon to see what's new!

NEWS: 2023/11/21: Upgrade and bug fix to documentation
The available documentation is:

* `Getting Started (install, etc.) <pages/readme_link.rst>`_
* `Usage and examples <pages/tutorials.rst>`_
* `Developers notes and how to contribute <pages/readmedev_link.rst>`_
* `Source code (GitHub) <https://github.com/vincenzooo/pyXsurf>`_


.. TODO: add icon work in progress to text inline
.. TODO: 
.. TODO: 

.. .. image:: resources/wip.png
   :width: 100px
   :height: 100px

.. .. figure:: resources/wip.png
   :align: left
   :width: 200px
   :height: 200px

   Your caption here.


pyXsurf API
===========

.. toctree::
    api 

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

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