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
fd6a54dfbc
docs: conf: fix conf for new alabaster theme version
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-24 19:44:50 +02:00
a76934ad33
docs: html: adapt sidebar in index page
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-24 19:41:19 +02:00
796480a38b
docs: add version and date to HTML index
...
Similar to the PDF output or the Proxmox VE docs.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-22 09:00:12 +02:00
8cce51135c
docs: do not render TODOs in release builts
...
they are not useful for endusers...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-11 11:09:00 +02:00
0cfe1b3f13
docs: set GmbH as copyright holder
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-11 11:08:36 +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
24406ebc0c
docs: move host sysadmin out to own chapter, fix ZFS one
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-08 18:15:33 +02:00
d87b193b0b
docs: todo: avoid leaking build details, link only
...
One can just search for them... If really wanted, we could set it to
true for dev builds (i.e., no DEB_VERSION defined)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-04 17:54:00 +02:00
1f6a4f587a
docs: do not hardcode version
...
use the debian package ones, if not defined we're doing a dev build
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-04 17:51:58 +02:00
5f249127b2
docs: sync version with the package versions
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-05-25 20:10:38 +02:00
25cf09065f
docs: use OpenSans as main font
...
Most people also read PDFs online ...
2020-05-04 10:48:09 +02:00
fc598cdbe1
docs: use better fonts for PDFs
...
Font XCharter and Lato have better quality.
2020-05-04 10:15:27 +02:00
bca294a17c
docs/conf.py: avoid font scale option
2020-05-04 09:02:10 +02:00
a02e8b1e95
docs/conf.py: fix baselineskip in code-blocks with scaled font
2020-05-03 09:22:01 +02:00
26d29e0ec7
pdf docs: scale down monospace font
2020-05-03 08:23:35 +02:00
15d74eaaf4
use xetex to generate pdf
...
To correctly handle unicode art in code blocks...
2020-05-03 07:48:55 +02:00
e4a5ab8ddb
add pxar.1 manual page
2019-11-17 17:13:59 +01:00
210cb53654
docs: enable sphinx todo items
2019-11-16 11:16:04 +01:00
c4f1b69f4e
docs: add sysadmin.rst, cleanups
2019-11-15 13:24:45 +01:00
861f8b8f44
docs/conf.py: add exclude_pattern package-repositories.rst
...
The file is inlcuded with 'include' directive. Exclude it to avoid
avoid warning about duplicate label definition.
2019-11-15 11:55:31 +01:00
028bd254ac
add manual page for proxmox-backup-manager
2019-11-11 09:17:55 +01:00
998b827a5d
start file format docu
2019-03-16 16:44:45 +01:00
b933ed7f80
docs: add manual page for proxmox-backup-proxy
2019-03-05 18:14:48 +01:00
3147e56a74
docs: add epilog.rst to define common things.
2019-03-02 10:31:32 +01:00
f13c36c856
docs: use exclude_pattern instead of :orphan:
...
Seems rst2man cannot handle :orphan:
2019-02-28 16:28:53 +01:00
7ef486ae06
build doc with sphinx
2019-02-27 17:42:31 +01:00
Thomas Lamprecht
Fabian Ebner
Oguz Bektas
Dietmar Maurer