diff options
author | Ronny Berndt <ronny@apache.org> | 2022-10-18 11:31:19 +0200 |
---|---|---|
committer | Ronny Berndt <ronny@apache.org> | 2022-10-18 11:31:19 +0200 |
commit | f34681d9f8f0fdf12d3efe0eb78da024ac45db43 (patch) | |
tree | b859d7c5016adee42c7c40c1bf1c54b1404760d7 | |
parent | f3950c52057f52fe4c5d8fa00946c5c1ea5e176e (diff) | |
download | couchdb-rtd-yaml.tar.gz |
Read the Docs configuration filertd-yaml
Using a configuration file is the
recommended way of using Read the Docs.
-rw-r--r-- | .readthedocs.yaml | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..6e938ccad --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,37 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may not +# use this file except in compliance with the License. You may obtain a copy of +# the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. + +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + builder: html + configuration: src/docs/src/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: all + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: src/docs/requirements.txt
\ No newline at end of file |