You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ro...@apache.org on 2022/10/18 09:31:37 UTC

[couchdb] branch rtd-yaml created (now f34681d9f)

This is an automated email from the ASF dual-hosted git repository.

ronny pushed a change to branch rtd-yaml
in repository https://gitbox.apache.org/repos/asf/couchdb.git


      at f34681d9f Read the Docs configuration file

This branch includes the following new commits:

     new f34681d9f Read the Docs configuration file

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[couchdb] 01/01: Read the Docs configuration file

Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ronny pushed a commit to branch rtd-yaml
in repository https://gitbox.apache.org/repos/asf/couchdb.git

commit f34681d9f8f0fdf12d3efe0eb78da024ac45db43
Author: Ronny Berndt <ro...@apache.org>
AuthorDate: Tue Oct 18 11:31:19 2022 +0200

    Read the Docs configuration file
    
    Using a configuration file is the
    recommended way of using Read the Docs.
---
 .readthedocs.yaml | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

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