From 8f7e4c75087a71b16704b3039521548681a4e5a3 Mon Sep 17 00:00:00 2001 From: sreea05 <258596614+sreea05@users.noreply.github.com> Date: Fri, 3 Apr 2026 12:27:01 +0100 Subject: [PATCH] C++: Rename docs_src/ as docs/ --- README.md | 4 ++-- cpp/{docs_src => docs}/Doxyfile | 2 +- cpp/{docs_src => docs}/api.rst | 0 cpp/{docs_src => docs}/conf.py | 0 cpp/{docs_src => docs}/index.rst | 0 justfile | 4 ++-- 6 files changed, 5 insertions(+), 5 deletions(-) rename cpp/{docs_src => docs}/Doxyfile (97%) rename cpp/{docs_src => docs}/api.rst (100%) rename cpp/{docs_src => docs}/conf.py (100%) rename cpp/{docs_src => docs}/index.rst (100%) diff --git a/README.md b/README.md index 1cb6855..24a4175 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ A **template** C++ library exposed to Python via [pybind11](https://github.com/p │ ├── CMakeLists.txt # Root — project settings, vcpkg toolchain, subdirectories │ ├── CMakePresets.json # Presets: release and debug (with coverage) │ ├── vcpkg.json # C++ dependencies: gtest -│ ├── docs_src/ # Docs config: Doxygen + Sphinx/Breathe source +│ ├── docs/ # Docs config: Doxygen + Sphinx/Breathe source │ │ ├── Doxyfile # Doxygen configuration for C++ API docs │ │ ├── conf.py │ │ ├── index.rst @@ -310,7 +310,7 @@ To rename `core_lib` / `_core` to your own project name (e.g. `my_lib` / `_my_li | `cpp/lib/CMakeLists.txt` | `add_library(core_lib ...)` and all `core_lib` target references | | `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` | | `cpp/lib/src/core_lib.cpp` | Rename file to `my_lib.cpp`; update `#include` and `namespace` | -| `cpp/docs_src/Doxyfile` | Update `PROJECT_NAME` to `"my_lib"` | +| `cpp/docs/Doxyfile` | Update `PROJECT_NAME` to `"my_lib"` | ### C++ bindings diff --git a/cpp/docs_src/Doxyfile b/cpp/docs/Doxyfile similarity index 97% rename from cpp/docs_src/Doxyfile rename to cpp/docs/Doxyfile index 4b158c8..bc9f41e 100644 --- a/cpp/docs_src/Doxyfile +++ b/cpp/docs/Doxyfile @@ -1,5 +1,5 @@ # Doxyfile — configuration for core_lib C++ API docs -# Generate with: cd cpp && doxygen docs_src/Doxyfile +# Generate with: cd cpp && doxygen docs/Doxyfile # Or via just: just cpp-docs PROJECT_NAME = "core_lib" diff --git a/cpp/docs_src/api.rst b/cpp/docs/api.rst similarity index 100% rename from cpp/docs_src/api.rst rename to cpp/docs/api.rst diff --git a/cpp/docs_src/conf.py b/cpp/docs/conf.py similarity index 100% rename from cpp/docs_src/conf.py rename to cpp/docs/conf.py diff --git a/cpp/docs_src/index.rst b/cpp/docs/index.rst similarity index 100% rename from cpp/docs_src/index.rst rename to cpp/docs/index.rst diff --git a/justfile b/justfile index 0562589..873d7ad 100644 --- a/justfile +++ b/justfile @@ -129,8 +129,8 @@ cpp-format-check: # Generate C++ API documentation (Doxygen + Sphinx/Breathe) cpp-docs: - cd {{cpp_dir}} && doxygen docs_src/Doxyfile - cd {{cpp_dir}} && "{{venv_bin}}/sphinx-build" -b html docs_src docs/sphinx + cd {{cpp_dir}} && doxygen docs/Doxyfile + cd {{cpp_dir}} && "{{venv_bin}}/sphinx-build" -b html docs docs/sphinx # Generate Python documentation (Sphinx) py-docs: