Skip to content
Snippets Groups Projects
Commit 0d7ef73c authored by Vadim Gubaidulin's avatar Vadim Gubaidulin
Browse files

Added sphinx documentation (to be tested with readthedocs)

parent 053eba2d
No related branches found
No related tags found
1 merge request!13v0.7.0
Showing
with 12049 additions and 0 deletions
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
.. mbtrack2 documentation master file, created by
sphinx-quickstart on Sun Apr 28 19:57:17 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to mbtrack2's documentation!
====================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
mbtrack2.impedance package
==========================
Submodules
----------
mbtrack2.impedance.csr module
-----------------------------
.. automodule:: mbtrack2.impedance.csr
:members:
:undoc-members:
:show-inheritance:
mbtrack2.impedance.impedance\_model module
------------------------------------------
.. automodule:: mbtrack2.impedance.impedance_model
:members:
:undoc-members:
:show-inheritance:
mbtrack2.impedance.resistive\_wall module
-----------------------------------------
.. automodule:: mbtrack2.impedance.resistive_wall
:members:
:undoc-members:
:show-inheritance:
mbtrack2.impedance.resonator module
-----------------------------------
.. automodule:: mbtrack2.impedance.resonator
:members:
:undoc-members:
:show-inheritance:
mbtrack2.impedance.tapers module
--------------------------------
.. automodule:: mbtrack2.impedance.tapers
:members:
:undoc-members:
:show-inheritance:
mbtrack2.impedance.wakefield module
-----------------------------------
.. automodule:: mbtrack2.impedance.wakefield
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mbtrack2.impedance
:members:
:undoc-members:
:show-inheritance:
mbtrack2.instability package
============================
Submodules
----------
mbtrack2.instability.instabilities module
-----------------------------------------
.. automodule:: mbtrack2.instability.instabilities
:members:
:undoc-members:
:show-inheritance:
mbtrack2.instability.ions module
--------------------------------
.. automodule:: mbtrack2.instability.ions
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mbtrack2.instability
:members:
:undoc-members:
:show-inheritance:
mbtrack2 package
================
Subpackages
-----------
.. toctree::
:maxdepth: 4
mbtrack2.impedance
mbtrack2.instability
mbtrack2.tracking
mbtrack2.utilities
Module contents
---------------
.. automodule:: mbtrack2
:members:
:undoc-members:
:show-inheritance:
mbtrack2.tracking.monitors package
==================================
Submodules
----------
mbtrack2.tracking.monitors.monitors module
------------------------------------------
.. automodule:: mbtrack2.tracking.monitors.monitors
:members:
:undoc-members:
:show-inheritance:
mbtrack2.tracking.monitors.plotting module
------------------------------------------
.. automodule:: mbtrack2.tracking.monitors.plotting
:members:
:undoc-members:
:show-inheritance:
mbtrack2.tracking.monitors.tools module
---------------------------------------
.. automodule:: mbtrack2.tracking.monitors.tools
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mbtrack2.tracking.monitors
:members:
:undoc-members:
:show-inheritance:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment