Skip to content

Commit

Permalink
docs: add .readthedocs.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
overcat committed Aug 27, 2023
1 parent 353df2a commit f0b012d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
31 changes: 31 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# .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.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/en/conf.py
builder: html
fail_on_warning: false

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- method: pip
path: .
- requirements: docs/requirements.txt

# Build PDF & ePub
formats:
- epub
- pdf
4 changes: 1 addition & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
Sphinx==7.2.3
sphinx-rtd-theme==1.3.0
sphinx-autodoc-typehints==1.24.0
autodoc-pydantic==2.0.1
# install stellar-sdk in the readthedocs.io environment
.
autodoc-pydantic==2.0.1

0 comments on commit f0b012d

Please sign in to comment.