Commit 83b89ce7 authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Merge branch 'staging_docs' into 'master' 

Convert docs to Markdown

Closes #161 and #147

See merge request allpix-squared/allpix-squared!734
parents e037aede bc1650a5

.editorconfig

+2 −1
Original line number Diff line number Diff line
@@ -14,4 +14,5 @@ indent_style = space 
indent_size = 4



[*.md]

trim_trailing_whitespace = false
 
indent_style = space

indent_size = 2

.gitignore

+5 −1
Original line number Diff line number Diff line
@@ -24,6 +24,10 @@ 
.*

\#*



# Some exceptions for the doc folder

!/doc/**/*.png

!/doc/**/.gitignore



# ignore python byte code

*.pyc

.gitlab-ci.yml

+23 −19
Original line number Diff line number Diff line
@@ -433,7 +433,7 @@ perf:cc7-gcc: 
    tags:

        - docker

    before_script:

        - mkdir -p public/usermanual

        - mkdir -p public

        - mkdir build && cd build

    artifacts:

        paths:
@@ -446,27 +446,30 @@ cmp:doxygen: 
    image: gitlab-registry.cern.ch/sft/docker/centos7:latest

    script:

        - source ../.ci/init_x86_64.sh

        - cmake -DBUILD_DOCS_ONLY=ON ..

        - make Allpix-reference 1> /dev/null

        - mv reference/html ../public/reference

        - cmake -GNinja -DBUILD_DOCS_ONLY=ON ..

        - ninja apsq_docs_reference

        - mv doc/reference/html ../public/reference



# Create file tree for hugo

cmp:usermanual-hugo:

    extends: .doc

    image: gitlab-registry.cern.ch/sft/docker/centos7:latest

    script:

        - source ../.ci/init_x86_64.sh

        - cmake -GNinja -DBUILD_DOCS_ONLY=ON ..

        - ninja apsq_docs_hugo

        - mv doc/usermanual_hugo ../public/usermanual_hugo



# Compile LaTeX user manual:

cmp:usermanual:

cmp:usermanual-pdf:

    extends: .doc

    image: gitlab-registry.cern.ch/clicdp/publications/templates/custom_ci_worker:fedora-latex-latest

    image: thomasweise/docker-texlive-full:latest

    script:

        - cmake -DBUILD_DOCS_ONLY=ON ..

        - make pdf

        - make html

        - mv usermanual/*.html ../public/usermanual

        - mv usermanual/*.css ../public/usermanual

        - mv usermanual/logo.png ../public/usermanual

        - mv usermanual/allpix-manual.pdf ../public/usermanual

        - mkdir -p ../public/usermanual/usermanual/

        - mkdir -p ../public/usermanual/usermanual/html/

        - mv usermanual/usermanual/html/css ../public/usermanual/usermanual/html/

        - mv usermanual/usermanual/html/js ../public/usermanual/usermanual/html/

        - mv usermanual/usermanual/figures ../public/usermanual/usermanual/

        - apt update && apt install -y cmake ninja-build python3-yaml pandoc

        - pandoc --version

        - cmake -GNinja -DBUILD_DOCS_ONLY=ON ..

        - ninja apsq_docs_pdf

        - mv doc/usermanual_pdf/allpix-manual.pdf ../public/usermanual_pdf





################################
@@ -543,7 +546,8 @@ deploy-documentation: 
    only:

        - tags@allpix-squared/allpix-squared

    dependencies:

        - cmp:usermanual

        - cmp:usermanual-hugo

        - cmp:usermanual-pdf

        - cmp:doxygen

    # Docker image with tools to deploy to EOS

    image: gitlab-registry.cern.ch/ci-tools/ci-web-deployer:latest

.reuse/dep5

+6 −6
Original line number Diff line number Diff line
@@ -23,13 +23,13 @@ Files: cmake/CodeCoverage.cmake 
Copyright: 2012 - 2017, Lars Bilke

License: BSD-3-Clause



Files: cmake/LATEX.cmake

Copyright: 2004, 2015 Sandia Corporation

License: BSD-3-Clause

Files: doc/convert/pandoc-gitlab-math.lua

Copyright: 2018 Nikolay Yakimov

License: MIT



Files: cmake/PANDOC.cmake

Copyright: 2015 Jeet Sukumaran <jeetsukumaran@gmail.com>

License: BSD-3-Clause

Files: doc/convert/pandoc-minted.lua

Copyright: 2019 Stephen McDowell

License: MIT



Files: doc/*

Copyright: 2016-2022 CERN and the Allpix Squared authors

AUTHORS.md

0 → 100644
+63 −0
Original line number Diff line number Diff line 
---

# SPDX-FileCopyrightText: 2022 CERN and the Allpix Squared authors

# SPDX-License-Identifier: CC-BY-4.0

title: "Acknowledgments"

---



Allpix Squared is developed and maintained by



* Paul Schütze, DESY, @pschutze

* Simon Spannagel, DESY, @simonspa

* Koen Wolters, @kwolters



The following authors, in alphabetical order, have developed or contributed to Allpix Squared:



* Mohamed Moanis Ali, GSOC2019 Student, @mmoanis

* Mathieu Benoit, BNL, @mbenoit

* Thomas Billoud, Université de Montréal, @tbilloud

* Tobias Bisanz, CERN, @tbisanz

* Marco Bomben, Université de Paris, @mbomben

* Koen van den Brandt, Nikhef, @kvandenb

* Carsten Daniel Burgard, DESY, @cburgard

* Maximilian Felix Caspar, DESY, @mcaspar

* Liejian Chen, Institute of High Energy Physics Beijing, @chenlj

* Manuel Alejandro Del Rio Viera, DESY, @mdelriov

* Katharina Dort, University of Gie\ss en, @kdort

* Neal Gauvin, Université de Genève, @ngauvin

* Lennart Huth, DESY, @lhuth

* Daniel Hynds, University of Oxford, @dhynds

* Maoqiang Jing, University of South China, Institute of High Energy Physics Beijing, @mjing

* Moritz Kiehn, Université de Genève, @msmk

* Rafaella Eleni Kotitsa, CERN, @rkotitsa

* Stephan Lachnit, DESY, @slachnit

* Salman Maqbool, CERN Summer Student, @smaqbool

* Stefano Mersi, CERN, @mersi

* Ryuji Moriya, CERN Summer Student, University of Glasgow, @rmoriya

* Sebastien Murphy, ETHZ, @smurphy

* Andreas Matthias Nürnberg, KIT, @nurnberg

* Sebastian Pape, TU Dortmund University, @spape

* Marko Petric, CERN, @mpetric

* Radek Privara, Palacky University Olomouc, @rprivara

* Nashad Rahman, The Ohio State University, @nashadroid

* Sabita Rao, GSDocs2020 Student, @srao

* Edoardo Rossi, DESY, @edrossi

* Andre Sailer, CERN, @sailer

* Enrico Jr. Schioppa, Unisalento and INFN Lecce, @schioppa

* Sebastian Schmidt, FAU Erlangen, @schmidtseb

* Sanchit Sharma, Kansas State University, @SanchitKratos

* Xin Shi, Institute of High Energy Physics Beijing, @xshi

* Petr Smolyanskiy, Czech Technical Univbersity Prague, @psmolyan

* Viktor Sonesten, GSOC2018 Student, @tmplt

* Reem Taibah, Université de Paris, @retaibah

* Ondrej Theiner, Charles University, @otheiner

* Annika Vauth, University of Hamburg, @avauth

* Mateus Vicente Barreto Pinto, CERN, @mvicente

* Håkan Wennlöf, DESY, @hwennlof

* Andy Wharton, Lancaster University, @awharton

* Morag Williams, University of Glasgow, @williamm



The authors would also like to express their thanks to the developers of AllPix \[[@ap1wiki], [@ap1git]\].





[@ap1wiki]: https://twiki.cern.ch/twiki/bin/view/Main/AllPix

[@ap1git]: https://github.com/ALLPix/allpix