Skip to content

Commit 1c0159a

Browse files
committed
Enhance README contents
1 parent e30dbf6 commit 1c0159a

1 file changed

Lines changed: 29 additions & 13 deletions

File tree

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,35 @@ A **template** C++ library exposed to Python via [pybind11](https://github.com/p
88
99
## Table of contents
1010

11-
- [Project structure](#project-structure)
12-
- [Prerequisites](#prerequisites)
13-
- [Quick start](#quick-start)
14-
- [Building](#building)
15-
- [Running tests](#running-tests)
16-
- [Test coverage](#test-coverage)
17-
- [Lint and format](#lint-and-format)
18-
- [Documentation](#documentation)
19-
- [Building the Python package](#building-the-python-package)
20-
- [CI/CD](#cicd)
21-
- [Usage](#usage)
22-
- [Recipe reference](#recipe-reference)
23-
- [Customizing this template](#customizing-this-template)
11+
- [cpp-python](#cpp-python)
12+
- [Table of contents](#table-of-contents)
13+
- [Project structure](#project-structure)
14+
- [Prerequisites](#prerequisites)
15+
- [Quick start](#quick-start)
16+
- [Building](#building)
17+
- [Running tests](#running-tests)
18+
- [C++ tests (Google Test)](#c-tests-google-test)
19+
- [Python tests (pytest)](#python-tests-pytest)
20+
- [Test coverage](#test-coverage)
21+
- [C++ coverage (gcovr)](#c-coverage-gcovr)
22+
- [Python coverage (pytest-cov)](#python-coverage-pytest-cov)
23+
- [Lint and format](#lint-and-format)
24+
- [Python (ruff)](#python-ruff)
25+
- [C++ (clang-format)](#c-clang-format)
26+
- [Type checking (mypy)](#type-checking-mypy)
27+
- [Pre-commit hook](#pre-commit-hook)
28+
- [Documentation](#documentation)
29+
- [C++ API docs (Doxygen + Sphinx)](#c-api-docs-doxygen--sphinx)
30+
- [Python API docs (Sphinx)](#python-api-docs-sphinx)
31+
- [Building the Python package](#building-the-python-package)
32+
- [CI/CD](#cicd)
33+
- [Usage](#usage)
34+
- [Recipe reference](#recipe-reference)
35+
- [Customizing this template](#customizing-this-template)
36+
- [C++ library](#c-library)
37+
- [C++ bindings](#c-bindings)
38+
- [C++ tests](#c-tests)
39+
- [Python package](#python-package)
2440

2541
## Project structure
2642

0 commit comments

Comments
 (0)