Skip to content

Examples

Every directory in examples/ is a standalone project with its own docs/cpdocs.yml and ProperDocs site. The test suite builds them, and the root ProperDocs site mounts each example directly during its own build. Each example site is versioned with its explicit versions: list.

Example Shows Site
basic-cpp one compiled C++ library basic-cpp
cpp-templates specializations, concepts, requires-clauses, SFINAE and deduction guides cpp-templates
cpp-features feature-dependent API across three feature sets; the same project through tools/minibuild.py cpp-features
cpp-standards C++17, C++20 and C++23 APIs with standard-dependent functions and overloads cpp-standards
cmake-variants build variants in plain CMake: one of two implementations, MPI optionally, and a CUDA unit for the GPU implementation cmake-variants
generated-cpp API headers that only the build creates, from a template and from a data table; none is checked in generated-cpp
c-basic a C library c-basic
mixed a C++ unit and a Python unit in one project mixed
fortran-basic a Fortran module plus an implementation-only source file fortran-basic
python-basic a plain Python package, answered by cpdocs manifest python python-basic
rust-basic Cargo features plus nightly rustdoc JSON, with private implementation source still browseable rust-basic

A build framework that provides the hooks shows the variant space of cmake-variants declared with the BESA CMake framework instead; it is not built by the test suite.

There is no separate example-site build step. Both properdocs build and properdocs serve build these sites directly at examples/<name>/; during serve, they use the checked-out working tree.