proxmox-mirrors/proxmox-backup
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox-backup synced 2025-08-14 09:25:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: epilog: add version dynamically and drop unused AUTHOR replacement

Browse Source 
now that the man pages are generated from sphinx, not rst2man, they
got access to the conf.py and things like its rst_epilog variable.

Use that to set the correct version in there dynamically

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2022-07-14 16:50:50 +02:00
parent ed873dc6a4
commit c63688e031
2 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/conf.py
View File

@ -69,9 +69,6 @@ source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
epilog_file = open('epilog.rst', 'r')
rst_epilog = epilog_file.read()
# General information about the project.
project = 'Proxmox Backup'
copyright = '2019-2021, Proxmox Server Solutions GmbH'
@ -88,6 +85,10 @@ version = vstr(os.getenv('DEB_VERSION_UPSTREAM'))
# The full version, including alpha/beta/rc tags.
release = vstr(os.getenv('DEB_VERSION'))
epilog_file = open('epilog.rst', 'r')
rst_epilog = epilog_file.read()
rst_epilog += f"\n.. |VERSION| replace:: {version}"
man_pages = [
# CLI
('proxmox-backup-client/man1', 'proxmox-backup-client', 'Command line tool for Backup and Restore', [author], 1),

3
docs/epilog.rst
View File

@ -3,8 +3,6 @@
We use this file to define external links and common replacement
patterns.
.. |VERSION| replace:: 1.0
.. |AUTHOR| replace:: Proxmox Support Team <support@proxmox.com>
.. |WEBSITE| replace:: https://www.proxmox.com
.. |DOWNLOADS| replace:: https://www.proxmox.com/downloads
@ -40,4 +38,3 @@
.. _ISO Week date: https://en.wikipedia.org/wiki/ISO_week_date
.. _systemd.time manpage: https://manpages.debian.org/buster/systemd/systemd.time.7.en.html