Commit 08c1c74
committed
feat(sphinx-autodoc-sphinx): add :exclude: option to autoconfigvalues
why: two extensions (sphinx-gp-sitemap and sphinx-gp-llms) both
register site_url via app.add_config_value(). The autoconfigvalues
directive on both reference pages emits duplicate confval entries,
which Sphinx's RST domain warns about — breaking CI's -W build.
what:
- Add :exclude: option to AutoconfigvaluesDirective that accepts a
comma/whitespace-separated list of config value names to skip
- Add _parse_exclude() helper with doctests
- Use :exclude: site_url on sphinx-gp-llms reference page
- Document the option in sphinx-autodoc-sphinx tutorial1 parent 534f595 commit 08c1c74
3 files changed
Lines changed: 34 additions & 1 deletion
File tree
- docs/packages
- sphinx-autodoc-sphinx
- sphinx-gp-llms
- packages/sphinx-autodoc-sphinx/src/sphinx_autodoc_sphinx
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
12 | 13 | | |
Lines changed: 23 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
434 | 434 | | |
435 | 435 | | |
436 | 436 | | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
437 | 453 | | |
438 | 454 | | |
439 | 455 | | |
440 | 456 | | |
441 | 457 | | |
442 | | - | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
443 | 462 | | |
444 | 463 | | |
445 | 464 | | |
446 | 465 | | |
| 466 | + | |
447 | 467 | | |
448 | 468 | | |
| 469 | + | |
| 470 | + | |
449 | 471 | | |
450 | 472 | | |
451 | 473 | | |
| |||
0 commit comments