Added sphinx documentation (to be tested with readthedocs)

0d7ef73c · Vadim Gubaidulin · 053eba2d · 0d7ef73c · 0d7ef73c · 0d7ef73c
Commit 0d7ef73c authored 10 months ago by Vadim Gubaidulin
--- a/docs/Makefile
+++ b/docs/Makefile
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
--- a/docs/build/doctrees/environment.pickle
+++ b/docs/build/doctrees/environment.pickle
--- a/docs/build/doctrees/index.doctree
+++ b/docs/build/doctrees/index.doctree
--- a/docs/build/doctrees/mbtrack2.doctree
+++ b/docs/build/doctrees/mbtrack2.doctree
--- a/docs/build/doctrees/mbtrack2.impedance.doctree
+++ b/docs/build/doctrees/mbtrack2.impedance.doctree
--- a/docs/build/doctrees/mbtrack2.instability.doctree
+++ b/docs/build/doctrees/mbtrack2.instability.doctree
--- a/docs/build/doctrees/mbtrack2.tracking.doctree
+++ b/docs/build/doctrees/mbtrack2.tracking.doctree
--- a/docs/build/doctrees/mbtrack2.tracking.monitors.doctree
+++ b/docs/build/doctrees/mbtrack2.tracking.monitors.doctree
--- a/docs/build/doctrees/mbtrack2.utilities.doctree
+++ b/docs/build/doctrees/mbtrack2.utilities.doctree
--- a/docs/build/html/.buildinfo
+++ b/docs/build/html/.buildinfo
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 05f20f44309c0b23df92472b9aade71e
+tags: 645f666f9bcd5a90fca523b33c5a78b7
--- a/docs/build/html/_modules/index.html
+++ b/docs/build/html/_modules/index.html
+
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; mbtrack2 0.6.0 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/nature.css" />
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+    <script src="../_static/jquery.js"></script>
+    <script src="../_static/underscore.js"></script>
+    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="../_static/doctools.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">mbtrack2 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="mbtrack2/impedance/csr.html">mbtrack2.impedance.csr</a></li>
+<li><a href="mbtrack2/impedance/impedance_model.html">mbtrack2.impedance.impedance_model</a></li>
+<li><a href="mbtrack2/impedance/resistive_wall.html">mbtrack2.impedance.resistive_wall</a></li>
+<li><a href="mbtrack2/impedance/resonator.html">mbtrack2.impedance.resonator</a></li>
+<li><a href="mbtrack2/impedance/tapers.html">mbtrack2.impedance.tapers</a></li>
+<li><a href="mbtrack2/impedance/wakefield.html">mbtrack2.impedance.wakefield</a></li>
+<li><a href="mbtrack2/instability/instabilities.html">mbtrack2.instability.instabilities</a></li>
+<li><a href="mbtrack2/instability/ions.html">mbtrack2.instability.ions</a></li>
+<li><a href="mbtrack2/tracking/aperture.html">mbtrack2.tracking.aperture</a></li>
+<li><a href="mbtrack2/tracking/element.html">mbtrack2.tracking.element</a></li>
+<li><a href="mbtrack2/tracking/feedback.html">mbtrack2.tracking.feedback</a></li>
+<li><a href="mbtrack2/tracking/monitors/monitors.html">mbtrack2.tracking.monitors.monitors</a></li>
+<li><a href="mbtrack2/tracking/monitors/plotting.html">mbtrack2.tracking.monitors.plotting</a></li>
+<li><a href="mbtrack2/tracking/monitors/tools.html">mbtrack2.tracking.monitors.tools</a></li>
+<li><a href="mbtrack2/tracking/parallel.html">mbtrack2.tracking.parallel</a></li>
+<li><a href="mbtrack2/tracking/particles.html">mbtrack2.tracking.particles</a></li>
+<li><a href="mbtrack2/tracking/rf.html">mbtrack2.tracking.rf</a></li>
+<li><a href="mbtrack2/tracking/synchrotron.html">mbtrack2.tracking.synchrotron</a></li>
+<li><a href="mbtrack2/tracking/wakepotential.html">mbtrack2.tracking.wakepotential</a></li>
+<li><a href="mbtrack2/utilities/beamloading.html">mbtrack2.utilities.beamloading</a></li>
+<li><a href="mbtrack2/utilities/misc.html">mbtrack2.utilities.misc</a></li>
+<li><a href="mbtrack2/utilities/optics.html">mbtrack2.utilities.optics</a></li>
+<li><a href="mbtrack2/utilities/read_impedance.html">mbtrack2.utilities.read_impedance</a></li>
+<li><a href="mbtrack2/utilities/spectrum.html">mbtrack2.utilities.spectrum</a></li>
+</ul>
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">mbtrack2 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2024, A. Gamelin et al.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
+    </div>
+  </body>
+</html>
\ No newline at end of file
--- a/docs/build/html/_modules/mbtrack2/impedance/csr.html
+++ b/docs/build/html/_modules/mbtrack2/impedance/csr.html
--- a/docs/build/html/_modules/mbtrack2/impedance/impedance_model.html
+++ b/docs/build/html/_modules/mbtrack2/impedance/impedance_model.html
--- a/docs/build/html/_modules/mbtrack2/impedance/resistive_wall.html
+++ b/docs/build/html/_modules/mbtrack2/impedance/resistive_wall.html
--- a/docs/build/html/_modules/mbtrack2/impedance/resonator.html
+++ b/docs/build/html/_modules/mbtrack2/impedance/resonator.html
--- a/docs/build/html/_modules/mbtrack2/impedance/tapers.html
+++ b/docs/build/html/_modules/mbtrack2/impedance/tapers.html
--- a/docs/build/html/_modules/mbtrack2/impedance/wakefield.html
+++ b/docs/build/html/_modules/mbtrack2/impedance/wakefield.html
--- a/docs/build/html/_modules/mbtrack2/instability/instabilities.html
+++ b/docs/build/html/_modules/mbtrack2/instability/instabilities.html
--- a/docs/build/html/_modules/mbtrack2/instability/ions.html
+++ b/docs/build/html/_modules/mbtrack2/instability/ions.html
--- a/docs/build/html/_modules/mbtrack2/tracking/aperture.html
+++ b/docs/build/html/_modules/mbtrack2/tracking/aperture.html