Sphinx TIPS

公式ドキュメント

Sphinx — Sphinx documentation

Myst

その他ドキュメント

拡張

RSS Feed拡張(sphinxfeed)の使い方

  1. インストール

pip install sphinxfeed-lsaffre

  1. conf.pyに追加

extensions = [
    'sphinxfeed',
]
...
feed_base_url = 'https://YOUR_HOST_URL'
feed_author = 'YOUR NAME'
feed_description = "A longer description"
# optional options
feed_field_name = 'date'  # default value is "Publish Date"
feed_use_atom = False
use_dirhtml = False

  1. rstファイルの先頭に以下を追加

:date: 2025-01-06

MystのMarkdown形式の場合は以下のようにファイルの先頭に追加する。

---
date: 2025-01-05
---

  1. ビルド

make html

注意点としては、:dateフィールドの値がrss.xmlの日付より未来の場合のみ、rss.xmlに追加されることと対象がrstファイルのみである事。

HTML TIPS

テーマ