如何在标题中打印文档版本？

Question

我刚刚使用 sphinx-quickstart.exe 和 alabaster 主题创建了一个 Sphinx 文档。

我想在标题的某处打印文档的版本。

我在conf.py

中填充了version和release变量

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.

# -- Project information -----------------------------------------------------

project = 'MWE'
copyright = '2019, and1er'
author = 'and1er'

# The short X.Y version
version = '2.4.12'
# The full version, including alpha/beta/rc tags
release = 'beta'

extensions = [
]

templates_path = ['_templates']
source_suffix = '.rst'

master_doc = 'index'
language = None
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
pygments_style = 'sphinx'

html_theme = 'alabaster'

html_static_path = ['_static']
htmlhelp_basename = 'MWEdoc'

index.rst

.. MWE documentation master file, created by
    sphinx-quickstart on Tue Feb  5 14:51:07 2019.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.

Welcome to MWE's documentation!
===============================

.. toctree::
    :maxdepth: 2
    :caption: Contents:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

生成的文档没有 2.4.12 或 beta 字符串。

Answer 1

|version|substitution适合你吗？

UPD 更新的 MWE

index.rst

.. MWE documentation master file, created by
   sphinx-quickstart on Tue Feb  5 14:51:07 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to MWE's documentation!
===============================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Document version:
|version|
|release|


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Answer 2

除了@Slam 提到的替换之外，您可以避免为项目 conf.py 中的每个版本手动更新此设置。

import pkg_resources
version = pkg_resources.get_distribution('myproject').version
release = version

然后 |release| 可以放在您的 reST 源文件中或 {{ release }} 放在您的主题模板中。

如何在标题中打印文档版本？

How to print the document version in the title?

python

versioning

restructuredtext

python-sphinx