diff --git a/documentation/bandpass/notes0.rst b/documentation/bandpass/notes0.txt similarity index 100% rename from documentation/bandpass/notes0.rst rename to documentation/bandpass/notes0.txt diff --git a/documentation/_static/README.rst b/documentation/chapters/README.rst similarity index 100% rename from documentation/_static/README.rst rename to documentation/chapters/README.rst diff --git a/documentation/_static/api.rst b/documentation/chapters/api.rst similarity index 100% rename from documentation/_static/api.rst rename to documentation/chapters/api.rst diff --git a/documentation/bandpass/bandpass.rst b/documentation/chapters/bandpass.rst similarity index 99% rename from documentation/bandpass/bandpass.rst rename to documentation/chapters/bandpass.rst index 1c9c16e989ff03d2da9e709cae101406f2256476..400dffe56253418aa586782ab6a783f6e407ba4a 100644 --- a/documentation/bandpass/bandpass.rst +++ b/documentation/chapters/bandpass.rst @@ -7,8 +7,10 @@ Example problem: Statistics of band-passed fields. Please see + Drivas, T. D. and Johnson, P. L. and Lalescu, C. C. and Wilczek, M. Phys Rev Fluids 2 104603 (2017) https://dx.doi.org/10.1103/PhysRevFluids.2.104603 + The relevant files are `cpp/full_code/bandpass_stats.?pp`, `TurTLE/PP.py` and `CMakeLists.txt` (the list of headers should be updated). diff --git a/documentation/_static/cpp.rst b/documentation/chapters/cpp.rst similarity index 100% rename from documentation/_static/cpp.rst rename to documentation/chapters/cpp.rst diff --git a/documentation/chapters/cpp_doxygen.rst b/documentation/chapters/cpp_doxygen.rst new file mode 100644 index 0000000000000000000000000000000000000000..8e01acdfc771afbcada0fd2ba67bd46287ed789c --- /dev/null +++ b/documentation/chapters/cpp_doxygen.rst @@ -0,0 +1,7 @@ +--- +CPP +--- + +.. doxygenclass:: direct_numerical_simulation + :project: TurTLE + :members: diff --git a/documentation/_static/development.rst b/documentation/chapters/development.rst similarity index 100% rename from documentation/_static/development.rst rename to documentation/chapters/development.rst diff --git a/documentation/_static/overview.rst b/documentation/chapters/overview.rst similarity index 100% rename from documentation/_static/overview.rst rename to documentation/chapters/overview.rst diff --git a/documentation/index.rst b/documentation/index.rst index 39bd5e86c5988cacabf3374fc2955f2f39d35132..fc866054f00a40fcc9c07d1f0adfea7f8da81250 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -9,15 +9,15 @@ Welcome to TurTLE's documentation! Contents: .. toctree:: - :maxdepth: 4 - - /_static/README - /_static/overview - /_static/development - bandpass/bandpass - /_static/api - /_static/cpp - /_static/cpp_doxygen + :maxdepth: 4 + + chapters/README + chapters/overview + chapters/development + chapters/bandpass + chapters/api + chapters/cpp + chapters/cpp_doxygen Indices and tables