nikola は使いこなせなくて短命に終わってしまった。 doit は面白いと思うのだが。
ということで、 sphinx プラグインの ABlog です。
はまり1: Sphinx のキャッシュ
python -m sphinx content build にデバッガをアタッチして試行錯誤するのだけど、
キャッシュされて処理されなかった。
python -m sphinx content build -E -v とする。
- -E: 全処理(キャッシュを使わない)
- -v: 詳細メッセージ
はまり2: ablog が timezone の有無で日付の比較に失敗する
can't compare offset-naive and offset-aware datetimesこれは、既存記事の frontmatter の日付に timezone が付いていると
日付の比較に失敗する。
# site-packages/ablog/blog.py:382self.date = date = info["date"].replace(tzinfo=None)と対処した。
はまり3: myst-parser の toml frontmatter 対応
myst-parser が --- による yaml 形式の frontmatter にしか対応していない様子。
hugo の frontmatter にある toml 様式に対応するべく改造したい。
切り出し
どこで処理しているのか探索が難航した。
site-packages/mdit_py_plugins/front_matter/index.py
で処理している。
Parse
site-packages/myst_parser/docutils_renderer.py
render_front_matter で切り出した文字列を yaml でパースしている。
except 節で toml にリトライさせたら動いた。
モンキーパッチ
とりあえず conf.py にて直接修正する。
後で PR 送ったりできるかな。
ABlog は何をしているのか
toctree無しのpost記事
特定の条件で、記事をブログ記事と見做して toctree 無しで辿れるようにする。
記事は、日付やタグでグループ化してくれる。
パス指定。
blog_post_pattern = "posts/**/*.md"条件。
if "blogpost" not in metadata and self.env.docname not in self.config.matched_blog_posts: return Nonefrontmatter 等から最低限、日付の情報がとれないとトップページから辿る方法が無い状態になる。
あと sphinx なのでトップレベルの表題が本文側に必要かも。
frontmatter の title を反映できると便利そう。
event: ‘doctree-read’
doctree から PostNode を集める。
alog/post#process_posts(app, doctree)
def process_posts(app, doctree): post_nodes = list(doctree.traverse(PostNode)) if not post_nodes: # PostNode が必要 return
# 省略
postinfo = { "docname": docname, "section": section_name, "order": order, "date": date, "update": max(update_dates + [date]), "title": title, "excerpt": excerpt, "tags": node["tags"], "author": node["author"], "category": node["category"], "location": node["location"], "language": node["language"], "redirect": node["redirect"], "nocomments": node["nocomments"], "image": node["image"], "exclude": node["exclude"], "doctree": section_copy, }
if docname not in env.ablog_posts: env.ablog_posts[docname] = [] env.ablog_posts[docname].append(postinfo)class CheckFrontMatter(SphinxTransform): def apply(): pass
def setup(app): app.add_transform(CheckFrontMatter)追加のページ生成
ablog/templates に格納されている。
# -- ABlog Sidebars -------------------------------------------------------
# There are seven sidebars you can include in your HTML output.# postcard.html provides information regarding the current post.# recentposts.html lists most recent five posts. Others provide# a link to a archive pages generated for each tag, category, and year.# In addition, there are authors.html, languages.html, and locations.html# sidebars that link to author and location archive pages.html_sidebars = { '**': [ 'about.html', 'postcard.html', 'navigation.html', 'recentposts.html', 'tagcloud.html', 'categories.html', 'archives.html', 'searchbox.html', ],}これらに対して追加のページ生成を行っている。
genindex.html などのように。
ToDo
✅ タグが変
toml 由来の tag の処理に失敗している。
["python", "ssg", "sphinx"]
が、
["python""ssg""sphinx"]
になっちゃってる。
送ってみた。
v0.10.22 で修正。👍
✅ 日付のフォーマット
conf.py
post_date_format = r'%Y/%m/%d'post_date_format_short = r'%Y/%m'✅ 記事のURL
✅ 記事タイトルは最初の見出しではなく、frontmatter の title にしたい
MystParser を改造した。
わりと Sphinx わかってきた。
python でデバッガがアタッチできるとなんでもできる(慣れ)。
[ ] tagの表記振れ
c++ と C++、c# と csharp などをたばねる。