esbo_ds/ESBO-ETC
esbo_ds/ESBO-ETC
11
0
Fork 1
Code Issues 1 Pull Requests Releases 1 Wiki Activity

Indentation fixedˆ

Browse Source
This commit is contained in:
Lukas Klass 2020-08-27 09:08:40 +02:00
parent e2be650ea4
commit 55b890a47f
2 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/developer/pipeline.rst
View File

@ -20,13 +20,11 @@ Pipeline
The pipeline is divided into three steps:
1. **Test:** A docker image containing a complete python installation and a virtual environment is built using the Dockerfile in the root of the repo.
Afterwards all required python modules (see ``requirements.txt``) are being installed in the container and the unittests defined in ``tests`` executed.
If all tests pass, the pipeline continues with stage 2.
Afterwards all required python modules (see ``requirements.txt``) are being installed in the container and the unittests defined in ``tests`` executed.
If all tests pass, the pipeline continues with stage 2.
2. **Build Docs:** The documentation is being build using the previous docker image.
After all required python modules have been installed, the build process using sphinx is started.
The results of the build process (all website files) are archived (stashed) for the next stage of the pipeline as shown in the image above.
After all required python modules have been installed, the build process using sphinx is started.
The results of the build process (all website files) are archived (stashed) for the next stage of the pipeline as shown in the image above.
3. **Deploy Docs:** The last stage of the pipeline is run locally on the ESBO-DS VM.
The build results from the previous stage are unarchived and copied to the webroot of the webserver.
The build results from the previous stage are unarchived and copied to the webroot of the webserver.

4
docs/source/usage/getting_started.rst
View File

@ -150,6 +150,6 @@ Sensor
Currently, two sensor components are available:
* The **imager** detector for generic imaging sensors like CCDs providing many parameters to adapt the component
to the needs like the dark current, the read noise, pixel size, array size but also parameters for the photometric
aperture like the percentage of contained energy or the shape of the photometric aperture.
to the needs like the dark current, the read noise, pixel size, array size but also parameters for the photometric
aperture like the percentage of contained energy or the shape of the photometric aperture.
* The **heterodyne** sensor for spectroscopy using the heterodyne principle providing also multiple parameters.