From 67793ef2cf36c9a92f3131f297d1c90b6327b776 Mon Sep 17 00:00:00 2001 From: Ivo Vellekoop Date: Fri, 11 Oct 2024 14:56:36 +0200 Subject: [PATCH] fixed documentation build warnings --- docs/source/acknowledgements.rst | 8 +++++--- docs/source/conf.py | 2 ++ docs/source/core.rst | 2 +- docs/source/readme.rst | 2 +- 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/source/acknowledgements.rst b/docs/source/acknowledgements.rst index 2cca80c..e72e6bc 100644 --- a/docs/source/acknowledgements.rst +++ b/docs/source/acknowledgements.rst @@ -3,8 +3,10 @@ Acknowledgements We would like to thank Gerwin Osnabrugge, Bahareh Mastiani, Giulia Sereni, Siebe Meijer, Gijs Hannink, Merle van Gorsel, Michele Gintoli, Karina van Beek, Abhilash Thendiyammal, Lyuba Amitonova, and Tzu-Lun Wang for their contributions to earlier revisions of our wavefront shaping code. This work was supported by the European Research Council under the European Union's Horizon 2020 Programme / ERC Grant Agreement n° [678919], and the Dutch Research Council (NWO) through Vidi grant number 14879. -Conflict of interest statement ------------------------------------------------- -The authors declare no conflict of interest. +.. only:: latex + + Conflict of interest statement + ------------------------------------------------ + The authors declare no conflict of interest. .. bibliography:: diff --git a/docs/source/conf.py b/docs/source/conf.py index 090fd96..f78cba6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -168,6 +168,8 @@ def setup(app): def source_read(app, docname, source): + # put the acknowledgements at the end of the introduction or at the end of the conclusion, + # depending on the builder if docname == "readme" or docname == "conclusion": if (app.builder.name == "latex") == (docname == "conclusion"): source[0] = source[0].replace("%endmatter%", ".. include:: acknowledgements.rst") diff --git a/docs/source/core.rst b/docs/source/core.rst index 84488f1..407f6d3 100644 --- a/docs/source/core.rst +++ b/docs/source/core.rst @@ -1,4 +1,4 @@ -.. _key_concepts: +.. _section-key_concepts: Key concepts ================================================== diff --git a/docs/source/readme.rst b/docs/source/readme.rst index 4d9c97a..7ef3fbb 100644 --- a/docs/source/readme.rst +++ b/docs/source/readme.rst @@ -47,7 +47,7 @@ OpenWFS is a Python package that is primarily designed for performing and for si .. only:: latex - Here, we first show how to get started using OpenWFS for simulating and controlling wavefront shaping experiments. An in-depth discussion of the core design of OpenWFS is given in :numref:`Key concepts`. Key to any wavefront shaping experiment is the spatial light modulator. The support for advanced options like texture mapping and the use of a software lookup table are explained in :numref:`section-slms`. The tools for realistically simulating experiments, automatic troubleshooting of experiments, and Micro-Manager integration are discussed in :numref:`section-simulations`, :numref:`section-troubleshooting`, and :numref:`section-micromanager`, respectively. Finally, in :numref:`section-development`, we show how to write custom hardware control modules in order to extend the functionality of OpenWFS. + Here, we first show how to get started using OpenWFS for simulating and controlling wavefront shaping experiments. An in-depth discussion of the core design of OpenWFS is given in :numref:`section-key_concepts`. Key to any wavefront shaping experiment is the spatial light modulator. The support for advanced options like texture mapping and the use of a software lookup table are explained in :numref:`section-slms`. The tools for realistically simulating experiments, automatic troubleshooting of experiments, and Micro-Manager integration are discussed in :numref:`section-simulations`, :numref:`section-troubleshooting`, and :numref:`section-micromanager`, respectively. Finally, in :numref:`section-development`, we show how to write custom hardware control modules in order to extend the functionality of OpenWFS. Note that not all functionality of the package is covered in this document. We refer to the API documentation :cite:`openwfsdocumentation` for a complete overview of most recent version of the package.