diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 07eb81c9..8bdf9237 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,6 +7,7 @@ build: sphinx: configuration: docs/source/conf.py + fail_on_warning: true python: install: @@ -14,4 +15,4 @@ python: - method: pip path: . extra_requirements: - - docs \ No newline at end of file + - docs diff --git a/Makefile b/Makefile index d51d267c..0be80e53 100644 --- a/Makefile +++ b/Makefile @@ -63,7 +63,8 @@ executable: clean mv dist/ytdl-sub dist/ytdl-sub${EXEC_SUFFIX} docs: REGENERATE_DOCS=1 pytest tests/unit/docgen/test_docgen.py - sphinx-build --fail-on-warning --nitpicky -b html docs/source/ docs/build/ + sphinx-build --write-all --fail-on-warning --nitpicky -b html \ + "./docs/source/" "./docs/build/" clean: rm -rf \ .pytest_cache/ \ diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 2ed28fc2..113e14f8 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -37,7 +37,7 @@ Subscriptions Options --------------------- Download all subscriptions specified in each :doc:`subscriptions file -<./guides/getting_started/first_sub>`. +<./guides/getting_started/subscriptions>`. .. code-block:: @@ -60,7 +60,7 @@ Download Options ---------------- Download a single subscription in the form of CLI arguments instead of from :doc:`a -subscriptions file <./guides/getting_started/first_sub>`: +subscriptions file <./guides/getting_started/subscriptions>`: .. code-block::