Skip to content

Commit

Permalink
docs: specify sphinx dirhtml builder
Browse files Browse the repository at this point in the history
With the requirement of a configuration file, the default builder
of `dirhtml` that RTD used to use is no longer specified.
This leads to URLs ending in `.html` now, which
breaks other exisitng references.

Refs: psf#6603
Refs: https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-builder
Refs: https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.dirhtml.DirectoryHTMLBuilder

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
  • Loading branch information
miketheman committed Dec 23, 2023
1 parent 1396eb6 commit 242d311
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ build:
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
builder: "dirhtml"

# Optionally build your docs in additional formats such as PDF and ePub
formats:
Expand Down

0 comments on commit 242d311

Please sign in to comment.