Thomas Lamprecht e5f2903981 docs: make sphinx ignore the environment cache to avoid missing synopsis ... Pass the `-E` option to, quoting it's man-page, "don't use a saved environment (the structure caching all cross-references, but rebuild it completely." As with reusing the environment one gets some empty results for synopsis stuff depending on build order, for example the synopsis in the command-syntax appendix HTML output is empty while the same synopsis used for the dedicated HTML page is complete. By making the build-log more verbose I caught the attention of some emitted 'env-purge-doc' events from sphinx; while this itself might be harmless (I didn't followed the rat tail to its end), it made me a bit suspicious about caching and wrong/missing invalidation. With ignoring the environment this is fixed, a diffoscope comparison shows that not only the command-syntax page, but many others have the various synposis content added again. There are solely added lines, no removed nor changed, so it seems fine to enabled that option without an in-depth sphinx review. Note, I first suspected the use of a separate "doctree pickles" cache directory (`-d` option) and is used for all output types besides the man-pages one, which uses the default .doctree directory. But changing the man-page target to also use the custom doctree cache had no effect on the build-result whatsoever (compared with diffoscope). Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>		2024-11-27 19:37:46 +01:00
..
_ext	docs/scanrefs: fix handling if ref is same as headline	2021-02-06 07:49:21 +01:00
_static	docs: move custom.js and custom.css into _static folder	2024-04-18 14:15:44 +02:00
_templates	docs: make logo path and index link absolute	2023-04-06 08:47:27 +02:00
api-viewer	docs: fix api viewer dark theme path	2023-05-17 11:39:54 +02:00
config	docs: add node.cfg man page	2024-10-18 17:56:17 +02:00
images	docs: images: add installer guide screenshots	2024-11-25 15:45:15 +01:00
lto-barcode	fix typos in strings	2024-08-07 16:49:31 +02:00
pbs2to3	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
pmt	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
pmtx	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
proxmox-backup	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
proxmox-backup-client	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
proxmox-backup-debug	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
proxmox-backup-manager	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
proxmox-backup-proxy	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
proxmox-file-restore	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
proxmox-tape	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
prune-simulator	docs: clarify prune settings slightly more	2024-02-22 08:59:30 +01:00
pxar	docs: avoid orphan warnings for man-page skeletons	2024-03-08 08:08:10 +01:00
backup-client.rst	docs: client: change disk name from backup to disk	2024-11-26 12:43:41 +01:00
backup-protocol.rst	docs: improve the occurrence of product website hyperlinks	2023-11-25 16:14:44 +01:00
calendarevents.rst	docs: improve the occurrence of product website hyperlinks	2023-11-25 16:14:44 +01:00
certificate-management.rst	docs: fix wrong product name in certificate docs	2024-11-21 16:59:22 +01:00
command-line-tools.rst	fix spelling of command line/command-line	2023-06-27 15:43:43 +02:00
command-syntax.rst	fix spelling of command line/command-line	2023-06-27 15:43:43 +02:00
conf.py	docs: update copyright years	2024-11-27 12:43:23 +01:00
configuration-files.rst	docs: add node.cfg man page	2024-10-18 17:56:17 +02:00
epilog.rst	docs: fix typos	2023-11-25 16:14:44 +01:00
external-metric-server.rst	docs: fix warnings in external-metric-server page	2024-10-18 17:56:46 +02:00
faq-release-support-table.csv	docs: faq: move support table to CSV	2023-11-10 15:59:52 +01:00
faq.rst	tree-wide: fix various typos	2023-11-29 18:32:07 +01:00
file-formats.rst	docs: file formats: describe split pxar archive file layout	2024-06-05 16:39:42 +02:00
GFDL.rst	add license for docs (GFDL)	2019-11-11 19:45:44 +01:00
glossary.rst	docs: language fixup: faq and appendix	2021-11-02 07:12:07 +01:00
gui.rst	ui: add onlineHelp for consent-banner option	2024-11-26 12:00:08 +01:00
index.rst	docs: add documentation for notification system	2024-04-23 23:14:46 +02:00
installation-media.rst	docs: installation: several small fixes/improvements	2024-11-27 12:56:00 +01:00
installation.rst	docs: installation: several small fixes/improvements	2024-11-27 12:56:00 +01:00
introduction.rst	docs: fix typos	2023-11-25 16:14:44 +01:00
local-zfs.rst	docs: add installation wizard guide	2024-11-25 15:44:27 +01:00
maintenance.rst	docs: deduplicate background details for garbage collection	2024-11-25 11:52:26 +01:00
Makefile	docs: make sphinx ignore the environment cache to avoid missing synopsis	2024-11-27 19:37:46 +01:00
managing-remotes.rst	docs: mention required source audit permission for push sync jobs	2024-11-27 13:20:22 +01:00
markdown-primer.rst	docs: fix typos	2023-11-25 16:14:44 +01:00
meta-format-overview.dot	docs: file formats: describe split pxar archive file layout	2024-06-05 16:39:42 +02:00
network-management.rst	docs: improve the occurrence of product website hyperlinks	2023-11-25 16:14:44 +01:00
notifications.rst	docs: notification: add webhook endpoint documentation	2024-11-26 11:58:46 +01:00
output-format.rst	docs: language fixup: faq and appendix	2021-11-02 07:12:07 +01:00
package-repositories.rst	docs: installation: several small fixes/improvements	2024-11-27 12:56:00 +01:00
pbs-copyright.rst	docs: replace copyright years statement with single source of truth from conf	2022-07-14 16:54:56 +02:00
pve-integration.rst	docs: improve the occurrence of product website hyperlinks	2023-11-25 16:14:44 +01:00
pxar-format-overview.dot	start file format docu	2019-03-16 16:44:45 +01:00
pxar-tool.rst	fix spelling of command line/command-line	2023-06-27 15:43:43 +02:00
services.rst	docs: add proxmox-backup service description	2021-02-13 09:48:21 +01:00
storage.rst	docs: removable datastores: rephrasing and typos	2024-11-26 13:09:16 +01:00
sysadmin.rst	docs: fix warnings in external-metric-server page	2024-10-18 17:56:46 +02:00
system-booting.rst	docs: add further secure boot information, as in pve-docs	2023-11-29 14:07:49 +01:00
system-requirements.rst	docs: add installation wizard guide	2024-11-25 15:44:27 +01:00
tape-backup.rst	docs: tape: drop redefinition of systemd.time manpage link	2024-01-22 16:11:46 +01:00
technical-overview.rst	docs: explain some further caveats of the change detection modes	2024-11-26 12:22:35 +01:00
terminology.rst	docs: improve the occurrence of product website hyperlinks	2023-11-25 16:14:44 +01:00
todos.rst	docs: add missing todos	2020-07-08 18:14:17 +02:00
traffic-control.rst	docs: link all screenshots to their image file	2022-11-28 17:15:42 +01:00
user-management.rst	fix typos in docs an manual pages	2024-08-07 16:49:31 +02:00
using-the-installer.rst	docs: installation: several small fixes/improvements	2024-11-27 12:56:00 +01:00