Skip to content

Commit 8f7e4c7

Browse files
committed
C++: Rename docs_src/ as docs/
1 parent 9af197f commit 8f7e4c7

6 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A **template** C++ library exposed to Python via [pybind11](https://github.com/p
3535
│ ├── CMakeLists.txt # Root — project settings, vcpkg toolchain, subdirectories
3636
│ ├── CMakePresets.json # Presets: release and debug (with coverage)
3737
│ ├── vcpkg.json # C++ dependencies: gtest
38-
│ ├── docs_src/ # Docs config: Doxygen + Sphinx/Breathe source
38+
│ ├── docs/ # Docs config: Doxygen + Sphinx/Breathe source
3939
│ │ ├── Doxyfile # Doxygen configuration for C++ API docs
4040
│ │ ├── conf.py
4141
│ │ ├── index.rst
@@ -310,7 +310,7 @@ To rename `core_lib` / `_core` to your own project name (e.g. `my_lib` / `_my_li
310310
| `cpp/lib/CMakeLists.txt` | `add_library(core_lib ...)` and all `core_lib` target references |
311311
| `cpp/lib/inc/core_lib/core_lib.hpp` | Rename directory and file to `my_lib/my_lib.hpp`; update `namespace core_lib``namespace my_lib` |
312312
| `cpp/lib/src/core_lib.cpp` | Rename file to `my_lib.cpp`; update `#include` and `namespace` |
313-
| `cpp/docs_src/Doxyfile` | Update `PROJECT_NAME` to `"my_lib"` |
313+
| `cpp/docs/Doxyfile` | Update `PROJECT_NAME` to `"my_lib"` |
314314

315315
### C++ bindings
316316

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Doxyfile — configuration for core_lib C++ API docs
2-
# Generate with: cd cpp && doxygen docs_src/Doxyfile
2+
# Generate with: cd cpp && doxygen docs/Doxyfile
33
# Or via just: just cpp-docs
44

55
PROJECT_NAME = "core_lib"
File renamed without changes.
File renamed without changes.
File renamed without changes.

justfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ cpp-format-check:
129129

130130
# Generate C++ API documentation (Doxygen + Sphinx/Breathe)
131131
cpp-docs:
132-
cd {{cpp_dir}} && doxygen docs_src/Doxyfile
133-
cd {{cpp_dir}} && "{{venv_bin}}/sphinx-build" -b html docs_src docs/sphinx
132+
cd {{cpp_dir}} && doxygen docs/Doxyfile
133+
cd {{cpp_dir}} && "{{venv_bin}}/sphinx-build" -b html docs docs/sphinx
134134

135135
# Generate Python documentation (Sphinx)
136136
py-docs:

0 commit comments

Comments
 (0)