Move cpp/docs to docs

.github/workflows/ci.yml

@@ -178,7 +178,7 @@ jobs:
         run: ctest --test-dir build --build-config ${{ env.CMAKE_CONFIG }} --output-on-failure --parallel
 
       - name: Install packages for building docs (Linux)
-        working-directory: cpp/docs
+        working-directory: docs
         run: |
           sudo apt-get update
           sudo apt-get install -y --no-upgrade doxygen
@@ -187,7 +187,7 @@ jobs:
         if: runner.os == 'Linux'
 
       - name: Install packages for building docs (Windows)
-        working-directory: cpp/docs
+        working-directory: docs
         run: |
           curl -sSfLO https://github.com/doxygen/doxygen/releases/download/Release_1_13_2/doxygen-1.13.2.windows.x64.bin.zip
           Expand-Archive doxygen-1.13.2.windows.x64.bin.zip
@@ -199,8 +199,8 @@ jobs:
         if: runner.os == 'Windows'
 
       - name: Build docs
-        working-directory: cpp/docs
-        run: uv run -- sphinx-build -b html . ../build/docs/html
+        working-directory: docs
+        run: uv run -- sphinx-build -b html . build/html
 
       - name: Package the C++ wrapper
         working-directory: cpp/build

.github/workflows/release.yml

@@ -87,7 +87,7 @@ jobs:
           python-version: '3.13'
 
       - name: Install packages for building docs
-        working-directory: cpp/docs
+        working-directory: docs
         run: |
           curl -sSfLO https://github.com/doxygen/doxygen/releases/download/Release_1_13_2/doxygen-1.13.2.windows.x64.bin.zip
           Expand-Archive doxygen-1.13.2.windows.x64.bin.zip
@@ -98,8 +98,8 @@ jobs:
           uv sync
 
       - name: Build docs
-        working-directory: cpp
-        run: uv run -- sphinx-build -b html . ../build/docs/html
+        working-directory: docs
+        run: uv run -- sphinx-build -b html . build/html
 
       - name: Build archive
         id: build-archive

.gitignore

@@ -1,2 +1,4 @@
 /target
 /testing-plugins
+.venv/
+build/

README.md

@@ -75,10 +75,10 @@ cargo test
 
 ### API documentation
 
-The API documentation can be built and viewed using:
+The Rust API's reference documentation can be built and viewed using:
 
 ```
 cargo doc --open
 ```
 
-The C++ wrapper also has more general documentation.
+The `docs` directory contains more general documentation.

cpp/.gitignore

@@ -1 +0,0 @@
-/build

cpp/CMakeLists.txt

@@ -271,7 +271,7 @@ install(DIRECTORY "${CMAKE_SOURCE_DIR}/include/"
     DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
 
 if(LIBLOOT_INSTALL_DOCS)
-    install(DIRECTORY "${CMAKE_BINARY_DIR}/docs/html/"
+    install(DIRECTORY "${CMAKE_SOURCE_DIR}/../docs/build/html/"
         DESTINATION ${CMAKE_INSTALL_DOCDIR})
 endif()
 

cpp/README.md

@@ -66,12 +66,10 @@ ctest --test-dir build --output-on-failure --parallel -V
 Install [Doxygen](https://www.doxygen.nl/), Python and [uv](https://docs.astral.sh/uv/getting-started/installation/) and make sure they're accessible from your `PATH`, then run:
 
 ```
-cd docs
-uv run -- sphinx-build -b html . ../build/docs/html
+cd ../docs
+uv run -- sphinx-build -b html . build/html
 ```
 
-The documentation files for dependency licenses and copyright notices are auto-generated using [cargo-attribution](https://github.com/ameknite/cargo-attribution): to regenerate them run `py scripts/licenses.py`.
-
 ### Packaging
 
 To package the build:

docs/README.md

@@ -0,0 +1,12 @@
+# libloot Documentation
+
+This directory contains documentation for libloot and LOOT's metadata syntax. It does not include Rust API reference documentation: that is generated using `cargo doc`.
+
+To build the documentation, install [Doxygen](https://www.doxygen.nl/), Python and [uv](https://docs.astral.sh/uv/getting-started/installation/) and make sure they're accessible from your `PATH`, then run:
+
+```
+cd ../docs
+uv run -- sphinx-build -b html . build/html
+```
+
+The documentation files for dependency licenses and copyright notices are auto-generated using [cargo-attribution](https://github.com/ameknite/cargo-attribution): to regenerate them run `py scripts/licenses.py`. The script is hardcoded to generate files for the C++ wrapper's dependencies, but in practice that doesn't add any content over doing the same for just the core libloot Rust library.