Commit 87439ac9 authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Merge branch 'p-docs-change-code-langs' into 'master' 

doc: replace sh and toml code annotation with shell and ini

See merge request allpix-squared/allpix-squared!796
parents ea38fdd4 f0495276

README.md

+4 −4
Original line number Diff line number Diff line
@@ -25,14 +25,14 @@ For more details about the project please have a look at the website at https:// 
Docker images are provided for all releases and the latest development version of the framework.

To create a container from the latest Docker image and start an interactive shell session with the current host system path mounted to `/data`, run:



```sh

```shell

$ docker run --interactive --tty --volume "$(pwd)":/data --name=allpix-squared \

             gitlab-registry.cern.ch/allpix-squared/allpix-squared bash

```



Alternatively it is also possible to directly start the simulation instead of an interactive shell:



```sh

```shell

$ docker run --tty --rm --volume "$(pwd)":/data --name=allpix-squared \

             gitlab-registry.cern.ch/allpix-squared/allpix-squared "allpix -c my_simulation.conf"

```
@@ -45,7 +45,7 @@ More detailed information on the Docker images can be found in the user manual. 


Machines with a supported OS and the [CERN Virtual Machine File System (CVMFS)](https://cernvm.cern.ch/portal/filesystem) can load Allpix<sup>2</sup> and its dependencies from there by sourcing the respective environment:



```sh

```shell

$ source /cvmfs/clicdp.cern.ch/software/allpix-squared/<version>/x86_64-<system>-<compiler>-opt/setup.sh

```

where `<version>` should be replaced with the desired Allpix<sup>2</sup> version, e.g. `2.2.1` and `<system>` with the operating system of the executing machine (`centos7`, `centos8` or `mac11`). The compiler versions available via the `<compiler>` tag depend on the selected operating system.
@@ -72,7 +72,7 @@ $ source etc/scripts/setup_lxplus.sh 


Compilation TL;DR:



```sh

```shell

$ mkdir build && cd build/

$ cmake ..

$ make install

doc/README.md

+1 −1
Original line number Diff line number Diff line
@@ -105,7 +105,7 @@ also means that explicit backticks (like `` $` `` or `` ```math ``) can't be use 
## Testing the website



You can easily test the website of the documentation with your changes yourself by running:

```sh

```shell

git clone --recurse-submodules https://gitlab.cern.ch/allpix-squared/allpix-squared-website.git

APSQ_REPO=your_user_name/allpix-squared APSQ_REF=branch_name ./get_artifacts.sh

hugo server

doc/usermanual/01_introduction/04_quick_start.md

+2 −2
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ libraries, which need to be installed and loaded before using Allpix Squared. Fo 


The minimal, default installation can be obtained by executing the commands listed below.



```sh

```shell

git clone https://gitlab.cern.ch/allpix-squared/allpix-squared

cd allpix-squared

mkdir build && cd build/
@@ -26,7 +26,7 @@ cd .. 


The binary can then be executed with the provided example configuration file as follows:



```sh

```shell

bin/allpix -c examples/example.conf

```

doc/usermanual/02_installation/03_source_code.md

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ considered development versions and might exhibit unexpected behavior. 
For developers, it is recommended to always use the latest available version from the git `master` branch. The software

repository can be cloned as follows:



```sh

```shell

git clone https://gitlab.cern.ch/allpix-squared/allpix-squared

cd allpix-squared

```

doc/usermanual/02_installation/04_initializing_dependencies.md

+2 −2
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ attempted) should be executed. In a Bash terminal on a private Linux machine thi 
from their respective installation directories (replacing `<root_install_dir>` with the local ROOT installation directory and

likewise for Geant4):



```sh

```shell

source <root_install_dir>/bin/thisroot.sh

source <geant4_install_dir>/bin/geant4.sh

```
@@ -18,6 +18,6 @@ source <geant4_install_dir>/bin/geant4.sh 
On the CERN LXPLUS service, a standard initialization script is available to load all dependencies from the CVMFS

infrastructure. This script should be executed as follows (from the main repository directory):



```sh

```shell

source etc/scripts/setup_lxplus.sh

```