Commit 32850ae3 authored by Stephan Lachnit's avatar Stephan Lachnit
Browse files

Merge branch 'f-update-manual-structure' into 'master' 

Manual: Geometry as Separate Chapter

See merge request allpix-squared/allpix-squared!899
parents b0d5ec60 8f5e01df

CMakeLists.txt

+1 −1
Original line number Diff line number Diff line
@@ -103,7 +103,7 @@ ADD_SUBDIRECTORY(etc/unittests) 
OPTION(BUILD_DOCS_ONLY "Build documentation only" OFF)



# Variables to configure list of tests

SET(DOCS_TESTS_UNCONF "${CMAKE_CURRENT_SOURCE_DIR}/doc/usermanual/14_appendix/tests.md.in")

SET(DOCS_TESTS_UNCONF "${CMAKE_CURRENT_SOURCE_DIR}/doc/usermanual/15_appendix/tests.md.in")

SET(DOCS_TESTS_CONF "${CMAKE_CURRENT_BINARY_DIR}/doc/tests.md")



# Add targets for Doxygen code reference and user manual

doc/CMakeLists.txt

+6 −6
Original line number Diff line number Diff line
@@ -37,22 +37,22 @@ ADD_CUSTOM_TARGET( 
        "${CMAKE_CURRENT_SOURCE_DIR}/usermanual" "${DOCS_MARKDOWN_BINARY_DIR}"

    COMMAND

        Python::Interpreter "-B" ${DOCS_PYTHON_HELPER} "glob_readme"

        "${PROJECT_SOURCE_DIR}/src/modules" "${DOCS_MARKDOWN_BINARY_DIR}/07_modules"

        "${PROJECT_SOURCE_DIR}/src/modules" "${DOCS_MARKDOWN_BINARY_DIR}/08_modules"

    COMMAND

        Python::Interpreter "-B" ${DOCS_PYTHON_HELPER} "glob_readme"

        "${PROJECT_SOURCE_DIR}/examples" "${DOCS_MARKDOWN_BINARY_DIR}/08_examples"

        "${PROJECT_SOURCE_DIR}/examples" "${DOCS_MARKDOWN_BINARY_DIR}/09_examples"

    COMMAND

        Python::Interpreter "-B" ${DOCS_PYTHON_HELPER} "copylower"

        "${PROJECT_SOURCE_DIR}/CONTRIBUTING.md" "${DOCS_MARKDOWN_BINARY_DIR}/09_development"

        "${PROJECT_SOURCE_DIR}/CONTRIBUTING.md" "${DOCS_MARKDOWN_BINARY_DIR}/10_development"

    COMMAND

        Python::Interpreter "-B" ${DOCS_PYTHON_HELPER} "glob_readme"

        "${PROJECT_SOURCE_DIR}/tools" "${DOCS_MARKDOWN_BINARY_DIR}/13_additional"

        "${PROJECT_SOURCE_DIR}/tools" "${DOCS_MARKDOWN_BINARY_DIR}/14_additional"

    COMMAND

        Python::Interpreter "-B" ${DOCS_PYTHON_HELPER} "copylower"

        "${PROJECT_SOURCE_DIR}/AUTHORS.md" "${DOCS_MARKDOWN_BINARY_DIR}/14_appendix"

        "${PROJECT_SOURCE_DIR}/AUTHORS.md" "${DOCS_MARKDOWN_BINARY_DIR}/15_appendix"

    COMMAND

        Python::Interpreter "-B" ${DOCS_PYTHON_HELPER} "copylower"

        "${DOCS_TESTS_CONF}" "${DOCS_MARKDOWN_BINARY_DIR}/14_appendix"

        "${DOCS_TESTS_CONF}" "${DOCS_MARKDOWN_BINARY_DIR}/15_appendix"

    DEPENDS Python::Interpreter

    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/convert"

    COMMENT "Generating source tree of the Markdown documentation"

doc/README.md

+1 −1
Original line number Diff line number Diff line
@@ -92,7 +92,7 @@ The following notes should be taken for these fields: 
    for example module READMEs, the `weight` field must be omitted so that hugo sorts them alphabetically.



For modules, additional front matter tags have to be set, as explained in the

[documentation](./usermanual/09_development/03_new_module.md#readmemd).

[documentation](./usermanual/10_development/03_new_module.md#readmemd).



## Formulae

doc/usermanual/01_introduction/02_support.md

+2 −2
Original line number Diff line number Diff line
@@ -11,8 +11,8 @@ arising. Reports on issues, questions concerning the software as well as the doc 
are very much appreciated. These should preferably be brought up on the issues tracker of the project which can be found in

the repository \[[@ap2-issue-tracker]\]. General support questions are best asked in the forum \[[@ap2-forum]\].



The FAQ in [Chapter 12](../12_faq/_index.md) is good place to start looking if a question arises.

In particular [Section 12.6](../12_faq/06_debugging.md) should be consulted before opening a bug report.

The FAQ in [Chapter 13](../13_faq/_index.md) is good place to start looking if a question arises.

In particular [Section 13.6](../13_faq/06_debugging.md) should be consulted before opening a bug report.





[@ap2-issue-tracker]: https://gitlab.cern.ch/allpix-squared/allpix-squared/issues

doc/usermanual/01_introduction/03_contributing.md

+2 −2
Original line number Diff line number Diff line
@@ -12,8 +12,8 @@ on how to implement a specific feature. Getting in touch with other developers e 
time on features which already exist or are currently under development by other users.



An introduction to the development of Allpix Squared and its different tools is provided in

[Chapter 9](../09_development/_index.md), including a ["How to contribute" Section](../09_development/contributing.md)

describing the steps necessary to get involved in the development. [Chapter 10](../10_devtools/_index.md) details the tools

[Chapter 10](../10_development/_index.md), including a ["How to contribute" Section](../10_development/contributing.md)

describing the steps necessary to get involved in the development. [Chapter 11](../11_devtools/_index.md) details the tools

provided with the repository which ease and facilitate contributions and ensure code quality.