]> git.proxmox.com Git - proxmox-backup.git/commit - docs/conf.py
docs: let sphinx build man pages for better integration and less cruft
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Thu, 14 Jul 2022 14:41:43 +0000 (16:41 +0200)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Thu, 14 Jul 2022 14:54:56 +0000 (16:54 +0200)
commited873dc6a4570083cdbcfccfe64007555f9d9247
treeaeb7d699f18584691f88802bdfff4790cc03f270
parent5b5f18eb38a0ac33873e1ce589399d4da8de83ce
docs: let sphinx build man pages for better integration and less cruft

rst2man is only good for use in projects that don't use sphinx
already, as there it can help to avoid bringing in the full sphinx
dependencies and be easier to manage (as long as it stay small).

But we already use sphinx, so there's no point in managing the manual
pages in a separate, semi-related way that is quite restricted as we
have no access to sphinx infrastructure like conf.py defined
variables and helpers for things like the current version.

Besides that, we're rather big, so the complexity of sphinx can
shine, e.g., see the diffstat report from switching out rst2man for
sphinx:

22 files changed, 74 insertions(+), 347 deletions(-)

so 273 lines less in total is rather nice.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
22 files changed:
docs/Makefile
docs/conf.py
docs/config/acl/man5.rst
docs/config/datastore/man5.rst
docs/config/media-pool/man5.rst
docs/config/remote/man5.rst
docs/config/sync/man5.rst
docs/config/tape-job/man5.rst
docs/config/tape/man5.rst
docs/config/user/man5.rst
docs/config/verification/man5.rst
docs/pmt/man1.rst
docs/pmtx/man1.rst
docs/proxmox-backup-client/man1.rst
docs/proxmox-backup-debug/man1.rst
docs/proxmox-backup-manager/man1.rst
docs/proxmox-backup-proxy/description.rst
docs/proxmox-backup-proxy/man1.rst
docs/proxmox-backup/man1.rst
docs/proxmox-file-restore/man1.rst
docs/proxmox-tape/man1.rst
docs/pxar/man1.rst