Skip to content

C++: Rename docs_src/ as docs/ #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sreea05 merged 1 commit into from
Apr 3, 2026
Merged

C++: Rename docs_src/ as docs/ #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion cpp/docs_src/Doxyfile → cpp/docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
0 cpp/docs_src/api.rst → cpp/docs/api.rst
View file
Open in desktop
File renamed without changes.
0 cpp/docs_src/conf.py → cpp/docs/conf.py
View file
Open in desktop
File renamed without changes.
0 cpp/docs_src/index.rst → cpp/docs/index.rst
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading