detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-04-21 03:10:02 +02:00
Code Issues Actions Packages Releases Activity

docs

Browse Source
This commit is contained in:
maliakal_d 2022-12-07 13:09:17 +01:00
parent 91c3926eca
commit ce6c8cddf1
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
RELEASE.txt
View File

@ -980,6 +980,7 @@ This document describes the differences between v7.0.0.rc1 and v6.1.2
TroubleShooting: TroubleShooting:
https://slsdetectorgroup.github.io/devdoc/troubleshooting.html https://slsdetectorgroup.github.io/devdoc/troubleshooting.html
https://slsdetectorgroup.github.io/devdoc/troubleshooting.html#receiver-pc-tuning-options
Further Documentation: Further Documentation:
https://www.psi.ch/en/detectors/documentation https://www.psi.ch/en/detectors/documentation

20
docs/src/installation.rst
View File

@ -71,12 +71,12 @@ Build from source
git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git --branch 6.1.1 git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git --branch 6.1.1
| **Pybind** | **Pybind for Python**
| v7.0.0+: | v7.0.0+:
| pybind11 packaged into 'libs/pybind'. No longer a submodule. No need for "recursive" or "submodule update". | pybind11 packaged into 'libs/pybind'. No longer a submodule. No need for "recursive" or "submodule update".
| |
| Older versions: | Older versions:
| pybind11 is a submodule> Must be cloned using "recursive" and updated when switching between versions using the following commands. | pybind11 is a submodule. Must be cloned using "recursive" and updated when switching between versions using the following commands.
.. code-block:: bash .. code-block:: bash
@ -139,8 +139,8 @@ Example cmake options Comment
Build using in-build cmk.sh script Build using in-built cmk.sh script
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash .. code-block:: bash
@ -185,6 +185,7 @@ Build using in-build cmk.sh script
./cmk.sh -bj5 -q /usr/lib64 ./cmk.sh -bj5 -q /usr/lib64
Build on old distributions Build on old distributions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -204,8 +205,9 @@ using this compiler
make -j12 make -j12
Build this documentation Build this documentation
------------------------------- ^^^^^^^^^^^^^^^^^^^^^^^^
The documentation for the slsDetectorPackage is build using a combination The documentation for the slsDetectorPackage is build using a combination
of Doxygen, Sphinx and Breathe. The easiest way to install the dependencies of Doxygen, Sphinx and Breathe. The easiest way to install the dependencies
@ -213,11 +215,15 @@ is to use conda
.. code-block:: bash .. code-block:: bash
conda create -n myenv python sphinx sphinx_rtd_theme conda create -n myenv python sphinx_rtd_theme breathe
Then enable the option SLS_BUILD_DOCS to create the targets
.. code-block:: bash .. code-block:: bash
# using cmake or ccmake to enable DSLS_BUILD_DOCS
# outside slsDetecorPackage folder
mkdir build && cd build
cmake ../slsDetectorPackage -DSLS_BUILD_DOCS=ON
make docs # generate API docs and build Sphinx RST make docs # generate API docs and build Sphinx RST
make rst # rst only, saves time in case the API did not change make rst # rst only, saves time in case the API did not change