ブログ運用にAblogを活用する#
純粋なSphinxの機能よりも、もう少しブログっぽく運用したい場合にAblogを活用すると便利
Ablogとは#
sphinxの拡張機能で、ブログのような形式で記事を管理できる。カテゴリやタグを設定しておけば、それに基づいて記事一覧を生成してくれるのが便利。
Ablogでできるようになること#
カテゴリやタグで記事を分類
記事一覧の自動生成
自動アーカイブ
サイドバーサポート
ドラフト記事の作成
Ablogのインストール#
pipやposetry addでインストールし、conf.pyを少しいじればすぐ使える。詳細は公式ドキュメント参照
記事作成#
blogフォルダを作成し、その中に記事を作成。ファイルは手動作成でもよいし ablog post new-post で作成してもよい。
blog/2025-03-27-new-post.rst#
.. post:: 2025-03-27
:tags: sphinx, ablog
:category: python
新しい記事
================
これは新しい記事です。
記事一覧#
index.rstに以下のように記述すると、最新の5件の記事が表示される。
blog/index.rst#
.. postlist:: 5
:date: %Y/%m/%d
:format: {title} ({date})
:excerpts:
:expand: Read more ...
その他の機能#
自動アーカイブ#
Ablogはビルド時に自動でアーカイブ実行される。以下のような記述をすると、アーカイブページへのリンクが簡単に設置できる。
blog/index.rst#
- :ref:`タグ一覧 <blog-tags>`
- :ref:`カテゴリ一覧 <blog-categories>`
- :ref:`アーカイブ <blog-archives>`
参考URL
サイドバーサポート#
サイドバーには、タグ一覧やカテゴリ一覧、アーカイブへのリンクを設置することができる。当サイトの場合、secondary_sidebar_itemsに以下のように設定している。
conf.py#
html_theme_options = {
"secondary_sidebar_items": {
"**": [
"ablog/recentposts.html",
"ablog/tagcloud.html",
"ablog/categories.html",
"ablog/archives.html",
],
},
}
参考URL
ドラフト記事の作成#
記事のdate属性を未来日にしておけば、その記事はドラフト扱い。ビルド時には表示されない。sphinxは静的ページなので、未来日にビルドし直す必要がある。
所感#
日々の勉強メモを残せるように継続の基盤にしたいという思いは達成できそう。カテゴリやタグの整理自動や、ドラフト記事の作成などは重宝しそう。折角の機会なので、これを機にブログを継続していきたい。
記事情報
- 投稿日:
2025-04-01
- 著者:
mtakagishi
python環境の再構築
ablogで"/blog.html"と"/blog/index.html"の競合への対処