From 55b890a47f339b539ad08cfb8b8bd3f3bf9ccb08 Mon Sep 17 00:00:00 2001 From: LukasK13 Date: Thu, 27 Aug 2020 09:08:40 +0200 Subject: [PATCH] =?UTF-8?q?Indentation=20fixed=CB=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/developer/pipeline.rst | 12 +++++------- docs/source/usage/getting_started.rst | 4 ++-- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/source/developer/pipeline.rst b/docs/source/developer/pipeline.rst index 463ab8c..e2917bf 100644 --- a/docs/source/developer/pipeline.rst +++ b/docs/source/developer/pipeline.rst @@ -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. diff --git a/docs/source/usage/getting_started.rst b/docs/source/usage/getting_started.rst index 52ef2ef..f970015 100644 --- a/docs/source/usage/getting_started.rst +++ b/docs/source/usage/getting_started.rst @@ -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.