Skip to content

Commit

Permalink
docs: use starbase readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
syu-w committed Dec 1, 2023
1 parent ec8e794 commit 78a5a37
Showing 1 changed file with 8 additions and 21 deletions.
29 changes: 8 additions & 21 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,40 +1,27 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
---

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.10"
jobs:
post_checkout:
- git submodule update --init -- docs/sphinx-starter-pack
- make preparedocs
post_install:
- ./tools/mkdoclinks.sh

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
builder: dirhtml
fail_on_warning: true

# Build documentation with MkDocs
# mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF
formats:
- pdf
- epub

build:
os: ubuntu-22.04
tools:
python: "3"

# Optionally set the version of Python
# and requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
- docs

0 comments on commit 78a5a37

Please sign in to comment.