ytdl-sub/docs/source
Ross Patterson 321556ecf7
[DEV] docs: Sphinx stale cross refs false success (#1319)
* ci(docs): RTD Sphinx warnings false successes

Use the same options on readthedocs.com that we use locally to fail on all warnings,
mostly to better catch stale cross references.

* docs(usage): Yet another stale Sphinx cross ref

I confirmed the previous RTD CI fix in the previous commit by pushing it to a draft PR
before pushing this change and the RTD action failed with the warning this commit
fixes. After pushing this commit, the RTD action succeeded.

* build(docs): Sphinx stale cross refs false success

I figured out why I kept getting warnings for broken Sphinx cross-refs *after* the
changes that caused them have already been merged, changes I know I ran `$ make docs`
for before pushing. The issue is that by default Sphinx only builds changed files for
faster iterations while editing, but it only catches broken cross-refs when it builds
files. So if changing, for example, a section name in one page that is referenced from
another page that you do *not* change, then the warning will be missed until something
changes that other page, such as a pull or rebase.

I considered adding a separate `./Makefile` target for incremental builds
in the inner loop of making changes. But I opted to just remove the `--write-all` CLI
option locally while editing in the inner loop, because the uncommitted change will
remind me to revert it and run a full rebuild before pushing.
2025-08-29 15:59:06 -07:00
..
_static [DOCS] Tooling to auto-generate custom sphinx docs (#849) 2023-12-28 22:39:59 -08:00
config_reference [FEATURE] Override variable support for throttle protection ranges (#1315) 2025-08-28 23:55:57 -07:00
faq [DOCS] Clarify debugging, support, reporting (#1305) 2025-08-27 09:10:01 -07:00
guides [DOCS] usage: Stale CLI options help output (#1311) 2025-08-29 10:08:07 -07:00
prebuilt_presets [DOCS] Clarify the = YAML key prefix (#1297) 2025-08-24 09:17:38 -07:00
conf.py [DOCS] Various doc cleanups (#928) 2024-02-17 08:53:06 -08:00
debugging.rst [DOCS] usage: Stale CLI options help output (#1311) 2025-08-29 10:08:07 -07:00
deprecation_notices.rst [DOCS] Consistent headings, newlines, wraps (#1293) 2025-08-20 20:20:19 -07:00
index.rst [DOCS] Clarify debugging, support, reporting (#1305) 2025-08-27 09:10:01 -07:00
introduction.rst [DOCS] Various clarifications (#1289) 2025-08-22 07:17:32 -07:00
requirements.txt [BACKEND] Remove old format for video_tags, music_tags, download_strategy (#899) 2024-01-15 00:04:32 -08:00
usage.rst [DEV] docs: Sphinx stale cross refs false success (#1319) 2025-08-29 15:59:06 -07:00