Skip to content

Commit

Permalink
.readthedocs.yaml added
Browse files Browse the repository at this point in the history
  • Loading branch information
kskinoue0612 committed Aug 10, 2023
1 parent a7639c7 commit b3d6ef2
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# 必須 設定ファイルのバージョン
version: 2

# ビルドに使われるOS、pythoのバージョン、その他ツールの設定。
build:
os: ubuntu-22.04
tools:
python: "3.11"
# オプション:その他ツールのバージョン設定。
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Sphinx を使用して「docs/」ディレクトリにドキュメントを構築する
sphinx:
configuration: conf.py
# 別のビルダーを使用するように Sphinx を構成できます。たとえば、より単純な URL には dirhtml ビルダーを使用します。
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# 必要に応じて、PDF や ePub などの追加形式でドキュメントを作成します
formats:
- htmlzip
# - pdf
# - epub

# オプションですが推奨されます。ドキュメントを作成するために必要な Python 要件を宣言します。
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: requirements.txt
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
sphinx==5.2.3
sphinx_rtd_theme==1.2.2

0 comments on commit b3d6ef2

Please sign in to comment.