mirror of
https://github.com/kennethreitz/requests.git
synced 2026-06-05 06:46:15 +00:00
Mike Fiedler
242d3113c0
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: #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>
30 lines
738 B
YAML
30 lines
738 B
YAML
# Read the Docs configuration file for Sphinx projects
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
# Set the OS, Python version and other tools you might need
|
|
build:
|
|
os: ubuntu-22.04
|
|
tools:
|
|
python: "3.12"
|
|
|
|
# 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:
|
|
- pdf
|
|
- epub
|
|
|
|
# Optional but recommended, declare the Python requirements required
|
|
# to build your documentation
|
|
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
|
|
python:
|
|
install:
|
|
- path: .
|
|
- requirements: docs/requirements.txt
|