Skip to content

Commit 9cf15fd

Browse files
committed
docs: leave adoption.md out of the Sphinx build
The adoption census arrived on develop in #323 and this branch had been touching it: moving a % comment out of its BibTeX block, because Pygments' bibtex lexer rejects it and this branch sets fail_on_warning, and adding it to the toctree so the rendered docs could reach it. Stop doing both. adoption.md is now byte-identical to develop, its toctree entry is gone, and it is listed in exclude_patterns so Sphinx does not read it -- which is what keeps the warning-free build warning-free without editing someone else's page. It stays maintained for reading on GitHub, where its source links and pinned commit URLs belong anyway. sphinx-build -W is clean and no page links into it, so nothing is left dangling. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YUq1vM4g82TkaX2jvLmuQc
1 parent 01bafc4 commit 9cf15fd

3 files changed

Lines changed: 6 additions & 9 deletions

File tree

doc/adoption.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,8 +271,6 @@ To cite the edition you read, pin it to a commit: open the file on GitHub and pr
271271
<kbd>y</kbd>, or run `git log -1 --format=%H -- doc/adoption.md` in a clone. Each edition's
272272
permalink is the commit that bumped its version in the changelog below.
273273

274-
Replace `<commit>` below with the permalink of the edition you read.
275-
276274
```bibtex
277275
@techreport{libcachesim-adoption-census-2026,
278276
title = {libCacheSim Adoption Census},
@@ -281,6 +279,7 @@ Replace `<commit>` below with the permalink of the edition you read.
281279
number = {census v1.2.0},
282280
year = {2026},
283281
month = aug,
282+
% replace <commit> with the permalink of the edition you read
284283
url = {https://github.com/1a1a11a/libCacheSim/blob/<commit>/doc/adoption.md},
285284
note = {Census date 2026-08-13}
286285
}

doc/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@
3434
# html_extra_path below so the <img> tags in the guides resolve.
3535
"plot",
3636
"assets",
37+
# Maintained for reading on GitHub, where its source links and pinned
38+
# commit URLs belong. Sphinx is not asked to render it, which also keeps
39+
# the BibTeX block's % comment -- valid BibTeX that Pygments' lexer
40+
# rejects -- from failing the warning-free build.
41+
"adoption.md",
3742
]
3843

3944
# quickstart_traceAnalyzer.md embeds the plots with raw <img> tags, so the

doc/index.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,6 @@ memory_usage_profiling
4242
debug
4343
```
4444

45-
```{toctree}
46-
:maxdepth: 1
47-
:caption: About
48-
49-
adoption
50-
```
51-
5245
## Other resources
5346

5447
* [Python binding](https://github.com/cacheMon/libCacheSim-python) — easier API access, `pip install libcachesim`

0 commit comments

Comments
 (0)