5
0
mirror of git://git.proxmox.com/git/proxmox-backup.git synced 2025-01-07 17:18:03 +03:00
Commit Graph

11 Commits

Author SHA1 Message Date
Thomas Lamprecht
ffc62ac94d docs: avoid orphan warnings for man-page skeletons
Use the `:orphan:` special metadata field [0] to tell Sphinx that this
file is expected to not be included in any TOC-tree.

[0]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#special-metadata-fields

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-08 08:08:10 +01:00
Thomas Lamprecht
ed873dc6a4 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>
2022-07-14 16:54:56 +02:00
Dietmar Maurer
f458e97fda docs: split out output-format.rst 2021-02-13 08:54:23 +01:00
Dietmar Maurer
80bf9ae99b docs: add short descriptions for main binaries. 2021-02-13 08:43:54 +01:00
Oguz Bektas
bad6e32075 docs: fix typo in client manpage
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2021-01-18 13:52:11 +01:00
Dietmar Maurer
4bf0cc3b41 proxmox-backup-client/man1.rst: include catalog shell commands 2019-12-06 10:08:11 +01:00
Dietmar Maurer
b246b2a635 docs: define author and version inside epilog.rst 2019-03-05 17:42:48 +01:00
Dietmar Maurer
f13c36c856 docs: use exclude_pattern instead of :orphan:
Seems rst2man cannot handle :orphan:
2019-02-28 16:28:53 +01:00
Dietmar Maurer
7ef486ae06 build doc with sphinx 2019-02-27 17:42:31 +01:00
Dietmar Maurer
f0b5a3adfa docs/proxmox-backup.rst: start writing docs 2019-02-24 15:52:04 +01:00
Dietmar Maurer
bb5c770758 start generating manual pages
Depend on docutils-doc
2019-02-24 10:18:38 +01:00