ドキュメントを github page 上で見たい

[altnight]

目的

• github page 上で docs 以下のドキュメントを見ることができる。そのことで開発に必要な情報が閲覧しやすくなる。
  • sphinx でつくる想定

入出力

• 入力: .rst ファイル
• 出力: HTML ファイル(github.io上)

関連機能、影響範囲

• リグレッションの確認が必要となる箇所
  • なし
• この機能が使うデータを生成する機能(対象機能チケットへの関連付けでも可)
  • なし
• この機能が生成するデータを使う機能(対象機能チケットへの関連付けでも可)
  • なし

セキュリティ

• セキュリティ(権限など)がある場合は、その内容を記載
  • 秘匿情報は書かない
    • 現状でも .env で管理しているので特に変わらないにんしき

デモ方法

• URLや、簡単に確認するための操作手順
  • なし

[shimizukawa]

Read The Docs でいいんじゃない？