Skip to content

Commit ff8b74a

Browse files
committed
Remove obsolete Doxygen and Sphinx documentation tooling
1 parent 7b39005 commit ff8b74a

12 files changed

Lines changed: 29 additions & 2991 deletions

File tree

.coderabbit.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ reviews:
3131
# Path-specific review instructions
3232
# Note: Detailed C++/CUDA and Python review guidelines are in cpp/REVIEW_GUIDELINES.md and python/REVIEW_GUIDELINES.md
3333
path_instructions:
34-
- path: "docs/**/*"
34+
- path: "fern/**/*"
3535
instructions: |
3636
For documentation changes, focus on:
3737
- Accuracy: Verify code examples compile and run correctly
@@ -43,15 +43,15 @@ reviews:
4343
- path: "c/include/cuvs/**/*"
4444
instructions: |
4545
For public C API headers, additionally check:
46-
- Doxygen documentation for all public functions/classes
47-
- API changes flagged for docs/ updates
46+
- Doxygen-style source comments for all public functions/classes, consumed by the Fern API generator
47+
- API changes flagged for fern/ updates
4848
- Breaking changes require deprecation warnings and migration guide updates
4949
5050
- path: "cpp/include/cuvs/**/*"
5151
instructions: |
5252
For public C++ API headers, additionally check:
53-
- Doxygen documentation for all public functions/classes
54-
- API changes flagged for docs/ updates
53+
- Doxygen-style source comments for all public functions/classes, consumed by the Fern API generator
54+
- API changes flagged for fern/ updates
5555
- Breaking changes require deprecation warnings and migration guide updates
5656
5757
- path: "notebooks/**/*"
@@ -82,5 +82,5 @@ knowledge_base:
8282
filePatterns:
8383
- "cpp/REVIEW_GUIDELINES.md"
8484
- "python/REVIEW_GUIDELINES.md"
85-
- "docs/source/contributing.md"
86-
- "docs/source/developer_guide.md"
85+
- "fern/pages/contributing.md"
86+
- "fern/pages/developer_guide.md"

.github/workflows/pr.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,6 @@ jobs:
276276
- '!ci/validate_wheel.sh'
277277
- '!cpp/.clang-format'
278278
- '!cpp/.clang-tidy'
279-
- '!cpp/doxygen/**'
280279
- '!CODEOWNERS'
281280
- '!Dockerfile'
282281
- '!README.md'
@@ -338,7 +337,6 @@ jobs:
338337
- '!conda/**'
339338
- '!cpp/.clang-format'
340339
- '!cpp/.clang-tidy'
341-
- '!cpp/doxygen/**'
342340
- '!docs/**'
343341
- '!examples/**'
344342
- '!fern/**'

.gitignore

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,20 +58,9 @@ _skbuild
5858
*.qdstrm
5959
*.nvprof
6060

61-
## doxygen build check inside ci/checks/style.sh
62-
doxygen_check/
63-
6461
## cibuildwheel
6562
/wheelhouse
6663

67-
# doxygen
68-
_xml
69-
70-
# sphinx
71-
_html
72-
_text
73-
docs/source/_static/rust
74-
7564
# clang tooling
7665
compile_commands.json
7766
.clangd/

.pre-commit-config.yaml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,6 @@ repos:
173173
^[.]pre-commit-config[.]yaml$
174174
exclude: |
175175
(?x)^(
176-
docs/source/sphinxext/github_link[.]py$|
177176
cpp/cmake/modules/FindAVX[.]cmake$|
178177
cpp/src/neighbors/detail/faiss_distance_utils[.]h$|
179178
cpp/src/distance/detail/fused_distance_nn/gemm[.]h$|
@@ -185,13 +184,6 @@ repos:
185184
cpp/src/distance/detail/fused_distance_nn/custom_epilogue_with_broadcast[.]h$|
186185
rust/cuvs-sys/src/bindings[.]rs$
187186
)
188-
- id: verify-copyright
189-
name: verify-copyright-scikit-learn
190-
args: [--fix, --spdx, "--spdx-license-identifier=Apache-2.0 AND BSD-3-Clause"]
191-
files: |
192-
(?x)^(
193-
docs/source/sphinxext/github_link[.]py$
194-
)
195187
- id: verify-copyright
196188
name: verify-copyright-cutlass
197189
args: [--fix, --spdx, "--spdx-license-identifier=Apache-2.0 AND BSD-3-Clause"]

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ For more code examples of the Rust APIs, including a drop-in project templates,
198198

199199
## Contributing
200200

201-
If you are interested in contributing to the cuVS library, please read our [Contributing guidelines](docs/source/contributing.md). Refer to the [Developer Guide](docs/source/developer_guide.md) for details on the developer guidelines, workflows, and principles.
201+
If you are interested in contributing to the cuVS library, please read our [Contributing guidelines](fern/pages/contributing.md). Refer to the [Developer Guide](fern/pages/developer_guide.md) for details on the developer guidelines, workflows, and principles.
202202

203203
## References
204204

0 commit comments

Comments
 (0)