快速入门

安装

直接使用 pip 安装：

pip install sphinx-sitemap

或者使用 conda-forge 的 conda 安装：

conda install -c conda-forge sphinx-sitemap

用法

将 sphinx_sitemap 添加到你的 Sphinx conf.py 的 extensions 中。例如：

extensions = ['sphinx_sitemap']

在你的 Sphinx conf.py 中设置 html_baseurl 的值为你的文档的当前基础 URL。例如：

html_baseurl = 'https://my-site.com/docs/'

构建完成后，sphinx-sitemap 将输出 sitemap 的位置:

sitemap.xml was generated for URL https://my-site.com/docs/ in /path/to/_build/sitemap.xml

小技巧

在安装和升级后确认 sitemap 的准确性。

更多关于如何使用 sphinx-sitemap 的信息，请参见 高级配置。