Skip to content

docs: Doxygen via Doxybook2

Stephan Lachnit requested to merge slachnit/allpix-squared:p-api-reference-doxybook2 into master

Can be created via

cd build  # assuming a configured build folder
ninja apsq_docs_reference
doxybook2 -i doc/reference/xml -o /path/to/apsq-website/content/docs/15_api_ref -t ../doc/reference/.doxybook -c ../doc/reference/.doxybook/config.json

Beforehand, create a folder named content/docs/15_api_ref in your allpix-squared-website folder and add the following _index.md in there:

---
# SPDX-FileCopyrightText: 2022 CERN and the Allpix Squared authors
# SPDX-License-Identifier: CC-BY-4.0
title: "API Reference"
weight: 15
---

This is the API Reference for Allpix Squared.

Things that still need to be done:

  • CMake integration
  • CI integration
  • Document Doxybook2 in doc/README.md
  • Adjust links in usermanual to API reference
  • Take a look at visual stuff like private namespaces, external namespaces, timestamp in footer, etc.
  • Fix PDF not rendering due to verbatim \n
Edited by Simon Spannagel

Merge request reports