ABlog 用于 Sphinx

ABlog 是一个 Sphinx 插件,可以将任何文档或个人网站项目转换为一个成熟的博客,具有:

安装

你可以使用 pip 来安装 ABlog

pip install -U ablog

或者 miniconda:

conda config --add channels conda-forge
conda config --set channel_priority strict
conda install ablog

这也将安装 SphinxfeedgenInvoke,分别用于建立网站,使其看起来更漂亮并生成 feeds,以及运行部署命令。

入门

如果你正在开始一个新的项目,请参阅 ABlog 快速入门 指南。如果你已经有了一个项目,请在 conf.py 中做以下修改来启用博客:

# 1. Add 'ablog' and 'sphinx.ext.intersphinx' to the list of extensions
extensions = [
    '...',
    'ablog',
    'sphinx.ext.intersphinx',
]

它是如何发挥作用的

如果你是 Sphinx 和 reStructuredText 标记语言的新手,你可能会发现 reStructuredText 入门 很有用。一旦你有了内容(在 .rst 文件中),你可以使用 post 指令发布 任何页面,如下所示:

.. post:: Apr 15, 2014
   :tags: earth, love, peace
   :category: python
   :author: me
   :location: SF
   :language: en

另一种方法是:

:blogpost: true
:date: Oct 10, 2020
:author: Nabil Freij
:location: World
:category: Manual
:language: English

在文件的顶端。

ABlog 将索引所有如上所述发布的文件,并在 :tag::category: 等选项中指定的档案和资料中列出它们。

你也可以使用 postlist 指令包含一个帖子的列表。

.. postlist::
   :list-style: circle
   :category: Manual
   :format: {title}
   :sort:

对于 ABlog 文档,这可以转换为以下内容,在这里你可以找到更多关于配置和使用 ABlog 的信息:

https://readthedocs.org/projects/ablog/badge/?version=latest

Comments

comments powered by Disqus