Commit Graph

38 Commits

Author SHA1 Message Date
3832911d50 docs: remove backup protocol api dumps
We now have the api-viewer for that.
2021-02-26 19:00:08 +01:00
1adbc7c13c docs: install API viewer 2021-02-21 09:06:58 +01:00
7ca0ba4515 tape: add tape-job.cfg manual page 2021-02-15 07:05:39 +01:00
bebd4a7ca4 tape: generate proxmox-tape.1 manual page 2021-02-12 18:00:01 +01:00
9468e94412 tape: add pmt and pmtx command to tape-backup.rst 2021-02-12 17:45:55 +01:00
167e5406c3 Makefile: fix typo (s/madia-pool/media-pool/) 2021-02-12 12:18:25 +01:00
c111c9a931 tape: add manual page for tape.cfg 2021-02-12 12:09:08 +01:00
bb71e3a023 tape: add manual page for media-pool.cfg 2021-02-12 11:50:56 +01:00
5b7f44555e docs: add manual page for verification.cfg 2021-02-11 13:40:11 +01:00
2ca396c015 docs: add manual page for acl.cfg 2021-02-11 13:13:34 +01:00
d8dae16035 docs: add manual page fro sysc.cfg 2021-02-11 11:52:37 +01:00
6279b8f5a5 docs: add manukal page for remote.cfg 2021-02-11 11:25:15 +01:00
67cc79ec52 docs: add user.cfg.5 manual page 2021-02-10 16:51:05 +01:00
4a0d3a3e3f docs: add datastore.cfg.5 man page 2021-02-10 11:05:02 +01:00
4c209d6b10 install pmt binary 2021-02-05 12:42:20 +01:00
c972704477 install pmtx binary 2021-01-27 11:36:15 +01:00
4a227b54bf add LTO barcode generator App 2020-12-19 17:39:48 +01:00
21b552848a prune sim: make numberfields more similar to PBS's
by creating a new class that adds a clear trigger and also uses the
clear-trigger image. Code was taken from the one in PBS's prune window,
but we have default values here, so a bit of adapting was necessary. For
example, we don't want to reset to the original value (which might have
been one of the defaults) when clearing, but always to 'null'.

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-19 09:47:51 +01:00
8a40e22691 docs: scroll navigation to current active section
Add a custom JavaScript file to all HTML rendered docs output.

For now it only hosts a small code snipped which gets the current
active section link and bring it into view.
Needs to be triggered after DOM is initially loaded (which is still
before *all* resources like images, iframes, ... are necessarily
loaded), else the query cannot work.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-08 13:29:09 +01:00
3323798b54 include prune simulator in build
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
2020-11-06 09:59:24 +01:00
0d7e61f06f docs: buildsys: add more dependencies to html target
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-24 19:45:23 +02:00
05c16a6e59 docs: use alabaster theme
It's not all perfect (yet) but way cleaner and simpler to use than
the sphinx one.

Custom do the scrolling for the fixed side bar and make some other
slight adjustments.

Main issue for now is that the "Developer Appendix" is always shown
in the navigation tree, but we only include that toctree for
devbuilds...

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-11 11:08:13 +02:00
49df8ac115 docs: add prototype sphinx extension for online help
goes through the sections in the documents and creates the
OnlineHelpInfo.js file from the explicitly defined section labels which
are used in the js files with 'onlineHelp' variable.
2020-09-02 14:38:27 +02:00
3a9988638b docs: move todolist to own document, don't link in release build
It is always build for html, but not linked if the devbuild tag isn't
set. This tag is set in the Makefile if the $(BUILD_MODE) variable
isn't "release".

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-06 14:44:53 +02:00
fc598cdbe1 docs: use better fonts for PDFs
Font XCharter and Lato have better quality.
2020-05-04 10:15:27 +02:00
15d74eaaf4 use xetex to generate pdf
To correctly handle unicode art in code blocks...
2020-05-03 07:48:55 +02:00
da0e1e4021 various packaging fixes, bump version
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2019-12-20 12:55:32 +01:00
720776b81e generate separate proxmox-backup-docs package 2019-12-13 14:15:07 +01:00
4bf0cc3b41 proxmox-backup-client/man1.rst: include catalog shell commands 2019-12-06 10:08:11 +01:00
c5ff124143 docs/Makefile: remove paper settings (we set that in conf.py) 2019-12-03 16:51:43 +01:00
45cc157f7c docs: add backup reader protocol 2019-11-22 06:59:37 +01:00
e4a5ab8ddb add pxar.1 manual page 2019-11-17 17:13:59 +01:00
028bd254ac add manual page for proxmox-backup-manager 2019-11-11 09:17:55 +01:00
177db84b82 docs/backup-protocol.rst: add backup protocol docs 2019-06-04 17:33:12 +02:00
b933ed7f80 docs: add manual page for proxmox-backup-proxy 2019-03-05 18:14:48 +01:00
7ef486ae06 build doc with sphinx 2019-02-27 17:42:31 +01:00
2e05a1ca7d docs/Makefile: fix make dependency 2019-02-24 16:19:39 +01:00
bb5c770758 start generating manual pages
Depend on docutils-doc
2019-02-24 10:18:38 +01:00