Read the Docsへのホスト

GitHubのリポジトリを作成します。ここでは my-first-sphinx-docs とします。ビルドしたファイルなどを除外するため、 Add .gitignore で Python を選択します。

Create a new repository

.gitignore ファイルを作成し、 .venv と _build/ を無視します。

.gitignore

.venv
_build/

requirements.txt ファイルを作成し、必要なパッケージを記述します。

requirements.txt

Sphinx
myst-parser

.readthedocs.yaml を作成し、Read the Docsの設定を記述します。

.readthedocs.yaml

version: 2

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

python:
  install:
    - requirements: requirements.txt

sphinx:
  configuration: conf.py

コミットし、GitHubへプッシュします。 your_github_account はGitHubアカウント名を指定します。

コミットとGitHubへプッシュ

$ git init -b main
$ git remote add origin git@github.com:your_github_account/my-first-sphinx-docs.git
$ git add .
$ git commit -m "first commit"
$ git push origin main