Update the docstrings on all the tools files and start laying out the docs for real

This commit is contained in:
Abe Levitan committed 2019-09-03 18:49:45 -04:00
1 parent 1e3a98c599
commit de186592cb
42 files changed
+1181 -887

No files matched your search

+5
View File
@@ -0,0 +1,5 @@
Analysis
========
.. automodule:: CDTools.tools.analysis
:members:
+5
View File
@@ -0,0 +1,5 @@
Cmath
=====
.. automodule:: CDTools.tools.cmath
:members:
+5
View File
@@ -0,0 +1,5 @@
Data
====
.. automodule:: CDTools.tools.data
:members:
+5
View File
@@ -0,0 +1,5 @@
Image Processing
================
.. automodule:: CDTools.tools.image_processing
:members:
+17
View File
@@ -0,0 +1,17 @@
Tools
=====
.. toctree::
:maxdepth: 1
cmath
image_processing
data
initializers
interactions
propagators
measurements
losses
plotting
analysis
projectors
+5
View File
@@ -0,0 +1,5 @@
Initializers
============
.. automodule:: CDTools.tools.initializers
:members:
+5
View File
@@ -0,0 +1,5 @@
Interactions
============
.. automodule:: CDTools.tools.interactions
:members:
+5
View File
@@ -0,0 +1,5 @@
Losses
======
.. automodule:: CDTools.tools.losses
:members:
+5
View File
@@ -0,0 +1,5 @@
Measurements
============
.. automodule:: CDTools.tools.measurements
:members:
+5
View File
@@ -0,0 +1,5 @@
Plotting
========
.. automodule:: CDTools.tools.plotting
:members:
+5
View File
@@ -0,0 +1,5 @@
Projectors
==========
.. automodule:: CDTools.tools.projectors
:members:
+5
View File
@@ -0,0 +1,5 @@
Propagators
===========
.. automodule:: CDTools.tools.propagators
:members: