Skip to content

GitLab

Commit 84deadfe authored by Cristian Lalescu's avatar Cristian Lalescu
Browse files

Merge branch 'feature/documentation' into develop

parents e0aafef1 031990eb
Pipeline #63958 passed with stage
in 3 minutes and 51 seconds
Hide whitespace changes
Inline Side-by-side
CMakeLists.txt
View file @ 84deadfe
......@@ -54,6 +54,7 @@ project(TurTLE
LANGUAGES CXX)
set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})
set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/morse ${CMAKE_MODULE_PATH})
set(TURTLE_LIBS "")
......@@ -62,6 +63,79 @@ if(NDEBUG)
add_definitions(-DNDEBUG)
endif()
# taken from https://vicrucann.github.io/tutorials/quick-cmake-doxygen/
# indicate the documentation build as an option and set it to ON by default
option(BUILD_DOC "Build documentation" OFF)
# check if Doxygen is installed
find_package(Doxygen)
if (DOXYGEN_FOUND)
# set input and output files
set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/documentation/cpp/cpp_config)
set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
# request to configure the file
configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
message("Doxygen build started")
# note the option ALL which allows to build the docs together with the application
add_custom_target( doc_doxygen
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen"
VERBATIM )
else (DOXYGEN_FOUND)
message("Doxygen needs to be installed to generate the doxygen documentation")
endif (DOXYGEN_FOUND)
# check if sphinx is available
find_package(Sphinx)
if (SPHINX_FOUND)
if(NOT DEFINED SPHINX_THEME)
set(SPHINX_THEME default)
endif()
if(NOT DEFINED SPHINX_THEME_DIR)
set(SPHINX_THEME_DIR)
endif()
# configured documentation tools and intermediate build results
set(BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/sphinx_build")
# Sphinx cache with pickled ReST documents
set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/sphinx_doctrees")
# HTML output directory
set(SPHINX_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/sphinx_html")
# LaTeX output directory
set(SPHINX_LATEX_DIR "${CMAKE_CURRENT_BINARY_DIR}/sphinx_latex")
configure_file(
"${PROJECT_SOURCE_DIR}/documentation/conf.py.in"
"${BINARY_BUILD_DIR}/conf.py"
@ONLY)
add_custom_target(doc_html
${SPHINX_EXECUTABLE}
-q -b html
-c "${BINARY_BUILD_DIR}"
-d "${SPHINX_CACHE_DIR}"
"${PROJECT_SOURCE_DIR}/documentation"
"${SPHINX_HTML_DIR}"
COMMENT "Building HTML documentation with Sphinx")
add_custom_target(doc_latex
${SPHINX_EXECUTABLE}
-q -b latex
-c "${BINARY_BUILD_DIR}"
-d "${SPHINX_CACHE_DIR}"
"${PROJECT_SOURCE_DIR}/documentation"
"${SPHINX_LATEX_DIR}"
COMMENT "Building LaTeX documentation with Sphinx")
else (SPHINX_FOUND)
message("Sphinx needs to be installed to generate the full documentation")
endif (SPHINX_FOUND)
option(TIMING_OUTPUT "Toggle timing output. WARNING: memory usage is proportional to `niter_todo`" OFF)
if(TIMING_OUTPUT)
add_definitions(-DUSE_TIMINGOUTPUT)
......
README.rst
View file @ 84deadfe
.. image:: https://gitlab.mpcdf.mpg.de/mjr/bfps/badges/develop/build.svg
:target: https://gitlab.mpcdf.mpg.de/mjr/bfps/commits/develop
.. only:: html
.. image:: https://gitlab.mpcdf.mpg.de/mjr/bfps/badges/develop/build.svg
:target: https://gitlab.mpcdf.mpg.de/mjr/bfps/commits/develop
=========================================
Turbulence Tools: Lagrangian and Eulerian
......
cmake/FindSphinx.cmake 0 → 100644
View file @ 84deadfe
# taken from https://eb2.co/blog/2012/03/sphinx-and-cmake-beautiful-documentation-for-c---projects/
find_program(SPHINX_EXECUTABLE NAMES sphinx-build
HINTS
$ENV{SPHINX_DIR}
PATH_SUFFIXES bin
DOC "Sphinx documentation generator"
)
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(Sphinx DEFAULT_MSG
SPHINX_EXECUTABLE
)
mark_as_advanced(SPHINX_EXECUTABLE)
cpp/kspace.cpp
View file @ 84deadfe
......@@ -286,8 +286,8 @@ void kspace<be, dt>::ball_filter(
* Filter's Fourier space expression:
* \f[
* \hat{\phi^M_\ell}(k) =
* \exp(-\frac{(3.54 k \ell)^(122*(\ell)^(0.0836))}{2})
* \left( 1 + \frac{(k \eta/0.0636)^3.44}{1 + (k \eta/ 0.0621)^3.44} \right)^{1/2}
* \exp(-\frac{(3.54 k \ell)^{122 \ell^{0.0836}}}{2})
* \left( 1 + \frac{(k \eta/0.0636)^{3.44}}{1 + (k \eta/ 0.0621)^{3.44}} \right)^{1/2}
* \f]
*/
template <field_backend be,
......@@ -352,25 +352,33 @@ void kspace<be, dt>::Gauss_filter(
* a Gaussian filter and a sharp real space spherical filter.
*
* Filter expressions in real space are as follows:
* \f{eqnarray*}{
* \phi^b_\ell(r) &=&
* \frac{1}{\ell^3}\frac{6}{\pi} H(\ell/2 - r) \\
* \phi^g_\ell(r) &=&
* \f[
* \phi^b_\ell(r) =
* \frac{1}{\ell^3}\frac{6}{\pi} H(\ell/2 - r)
* \f]
* \f[
* \phi^g_\ell(r) =
* \frac{1}{\sigma_\ell^3}\frac{1}{(2\pi)^{3/2}}
* \exp\left(-\frac{1}{2}\left(\frac{r}{\sigma_\ell}\right)^2\right) \\
* \phi^s_\ell(r) &=&
* \exp\left(-\frac{1}{2}\left(\frac{r}{\sigma_\ell}\right)^2\right)
* \f]
* \f[
* \phi^s_\ell(r) =
* \frac{1}{2 \pi^2 r^3}
* \left(\sin k_\ell r - k_\ell r \cos k_\ell r\right)
* \f}
* \f]
* and the corresponding expressions in Fourier space are:
* \f{eqnarray*}{
* \hat{\phi^b_\ell}(k) &=&
* \f[
* \hat{\phi^b_\ell}(k) =
* \frac{3}{2(k\ell/2)^3}
* \left(2\sin (k \ell/2) - k \ell \cos (k \ell/2)\right) \\
* \hat{\phi^g_\ell}(k) &=&
* \exp\left(-\frac{1}{2}k^2 \sigma_\ell^2\right) \\
* \hat{\phi^s_\ell}(k) &=& H(k_\ell - k)
* \f}
* \left(2\sin (k \ell/2) - k \ell \cos (k \ell/2)\right)
* \f]
* \f[
* \hat{\phi^g_\ell}(k) =
* \exp\left(-\frac{1}{2}k^2 \sigma_\ell^2\right)
* \f]
* \f[
* \hat{\phi^s_\ell}(k) = H(k_\ell - k)
* \f]
*
* \f$ k_\ell \f$ is given as a parameter, and then we use
* \f[
......@@ -425,25 +433,38 @@ int kspace<be, dt>::filter(
* a Gaussian filter and a sharp real space spherical filter.
*
* Filter expressions in real space are as follows:
* \f{eqnarray*}{
* \phi^b_\ell(r) &=&
* \frac{1}{\ell^3}\frac{6}{\pi} H(\ell/2 - r) \\
* \phi^g_\ell(r) &=&
* \frac{1}{\sigma_\ell^3}\frac{1}{(2\pi)^{3/2}}
* \exp\left(-\frac{1}{2}\left(\frac{r}{\sigma_\ell}\right)^2\right) \\
* \phi^s_\ell(r) &=&
* \frac{1}{2 \pi^2 r^3}
* \left(\sin k_\ell r - k_\ell r \cos k_\ell r\right)
* \f}
* \rst
* .. math::
* :nowrap:
*
* \begin{eqnarray*}
* \phi^b_\ell(r) &=&
* \frac{1}{\ell^3}\frac{6}{\pi} H(\ell/2 - r) \\
* \phi^g_\ell(r) &=&
* \frac{1}{\sigma_\ell^3}\frac{1}{(2\pi)^{3/2}}
* \exp\left(-\frac{1}{2}\left(\frac{r}{\sigma_\ell}\right)^2\right) \\
* \phi^s_\ell(r) &=&
* \frac{1}{2 \pi^2 r^3}
* \left(\sin k_\ell r - k_\ell r \cos k_\ell r\right)
* \end{eqnarray*}
*
* \endrst
*
* and the corresponding expressions in Fourier space are:
* \f{eqnarray*}{
* \hat{\phi^b_\ell}(k) &=&
* \frac{3}{2(k\ell/2)^3}
* \left(2\sin (k \ell/2) - k \ell \cos (k \ell/2)\right) \\
* \hat{\phi^g_\ell}(k) &=&
* \exp\left(-\frac{1}{2}k^2 \sigma_\ell^2\right) \\
* \hat{\phi^s_\ell}(k) &=& H(k_\ell - k)
* \f}
* \rst
* .. math::
* :nowrap:
*
* \begin{eqnarray*}
* \hat{\phi^b_\ell}(k) &=&
* \frac{3}{2(k\ell/2)^3}
* \left(2\sin (k \ell/2) - k \ell \cos (k \ell/2)\right) \\
* \hat{\phi^g_\ell}(k) &=&
* \exp\left(-\frac{1}{2}k^2 \sigma_\ell^2\right) \\
* \hat{\phi^s_\ell}(k) &=& H(k_\ell - k)
* \end{eqnarray*}
*
* \endrst
*
* \f$\sigma_\ell\f$ and \f$k_\ell\f$ are calibrated such that the energy of
* the large scales is approximately the same (within the inertial range)
......
cpp/mainpage.dox 0 → 100644
View file @ 84deadfe
/** \mainpage
*
* Turbulence Tools: Lagrangian and Eulerian
* =========================================
*
* In brief, this code runs pseudospectral direct numerical simulations
* (DNS) of the incompressible Navier-Stokes equations, using FFTW 3, and
* it can integrate particle trajectories in the resulting fields.
*
* The Navier-Stokes solver has been extensively tested (tests are included
* in the repository), and it is working as expected. Parameters and
* statistics are stored in HDF5 format, together with code information, so
* simulation data should be "future proof" --- suggestions of possible
* improvements to the current approach are always welcome.
*
* The primary aim of TurTLE is to reduce the time spent on setting up and
* baby sitting DNS, as well as simplify the analysis of the generated
* data. The wish is that this Python package provides an easy and general
* way of constructing efficient specialized DNS C++ codes for different
* turbulence problems encountered in research. At the same time, the
* package should provide a unified way of postprocessing, and accessing
* the postprocessing results. The code therefore consists of two main
* parts: the pure C++ code, a set of loosely related "building blocks",
* and the Python code, which can generate C++ code using the pure classes,
* but with a significant degree of flexibility.
*
* The code user is expected to write a small python script that will
* properly define the DNS they are interested in running. That code will
* generate an executable that can then be run directly on the user's
* machine, or submitted to a queue on a cluster.
*
*/
documentation/Makefile deleted 100644 → 0
View file @ e0aafef1
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/bfps.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/bfps.qhc"
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/bfps"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/bfps"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
documentation/_static/api.rst → documentation/chapters/api.rst
View file @ 84deadfe
......@@ -3,41 +3,50 @@ API
===
----------
bfps.tools
----------
------------
TurTLE
------------
.. automodule:: bfps.tools
.. automodule:: TurTLE
:members:
:undoc-members:
:show-inheritance:
------------
TurTLE.tools
------------
-----------------
bfps.NavierStokes
-----------------
.. automodule:: TurTLE.tools
:members:
:undoc-members:
:show-inheritance:
.. automodule:: bfps.NavierStokes
-----------
TurTLE.TEST
-----------
.. automodule:: TurTLE.TEST
:members:
:undoc-members:
:show-inheritance:
-----------------
bfps.FluidConvert
-----------------
----------
TurTLE.DNS
----------
.. automodule:: bfps.FluidConvert
.. automodule:: TurTLE.DNS
:members:
:undoc-members:
:show-inheritance:
----------------
bfps.FluidResize
----------------
---------
TurTLE.PP
---------
.. automodule:: bfps.FluidResize
.. automodule:: TurTLE.PP
:members:
:undoc-members:
:show-inheritance:
......
documentation/bandpass/bandpass.rst → documentation/chapters/bandpass.rst
View file @ 84deadfe
-------------------------
--------------------------------
TurTLE: Post-processing tutorial
-------------------------
--------------------------------
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).
......
documentation/chapters/cpp_doxygen.rst 0 → 100644
View file @ 84deadfe
---
CPP
---
.. doxygenclass:: kspace
:project: TurTLE
:members:
.. doxygenclass:: field
:project: TurTLE
:members:
.. doxygenclass:: code_base
:project: TurTLE
:members:
.. doxygenclass:: direct_numerical_simulation
:project: TurTLE
:members:
.. doxygenclass:: NSVE
:project: TurTLE
:members:
documentation/_static/overview.rst → documentation/chapters/overview.rst
View file @ 84deadfe
......@@ -254,14 +254,14 @@ In brief the following takes place:
NavierStokes`` command.
2. reasonable DNS parameters are constructed from the command line
arguments.
4. ``c`` generates a parameter file ``<simname>.h5``, into which the
3. ``c`` generates a parameter file ``<simname>.h5``, into which the
various parameters are written.
``c`` also generates the various datasets that the backend code
will write into (statistics and other stuff).
3. ``c`` writes a C++ file that is compiled and linked against
4. ``c`` writes a C++ file that is compiled and linked against
``libbfps``.
4. ``c`` executes the C++ code using ``mpirun``.
5. the C++ code actually performs the DNS, and outputs various
5. ``c`` executes the C++ code using ``mpirun``.
6. the C++ code actually performs the DNS, and outputs various
results into the ``<simname>.h5`` file.
After the simulation is done, things are simpler.
......
documentation/conf.py → documentation/conf.py.in
View file @ 84deadfe
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# bfps documentation build configuration file, created by
# sphinx-quickstart on Thu Jan 21 20:53:27 2016.
# TurTLE documentation build configuration file, created by
# sphinx-quickstart on Sat Nov 16 10:17:05 2019.
#
# This file is execfile()d with the current directory set to its
# containing dir.
......@@ -15,13 +14,16 @@
import sys
import os
import shlex
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('@PROJECT_BINARY_DIR@/python'))
breathe_projects = {
'TurTLE' : os.path.abspath('@CMAKE_CURRENT_BINARY_DIR@/xml/'),
}
# -- General configuration ------------------------------------------------
......@@ -32,13 +34,15 @@ sys.path.insert(0, os.path.abspath('..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'breathe',
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.imgconverter',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']