5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-04 05:17:47 +03:00
Commit Graph

33 Commits

Author SHA1 Message Date
Thomas Lamprecht
4a06054e39 doc-generator: ship our pve-docbook config and use it for manpages
so that it can also be used when generating per-package docs like
manpages.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 17:59:56 +01:00
Thomas Lamprecht
3bd81d8da2 asciidoc-pve: small code/style cleanups
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-01-03 13:27:30 +01:00
Stefan Sterz
1f0e8a1624 asciidoc-pve: disallow certain characters in onlineHelp keys
this removes the lazily evaluated part of the regex used to detect
`onlineHelp` keys in order to match them with asciidoc anchors in the
documentation. it uses a pattern that excludes curly braces, brackets
and quotations instead. this allows for greedy matching and also
removes an issue where keys that are set via CBind were included
incorrectly. the script would try to find an anchor name that was
equivalent to the CBind placeholder, which would fail.

since brackets, curly braces and quotation marks aren't allowed in
asciidoc anchors anyway, excluding them like this should be safe.

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
2022-11-14 14:27:16 +01:00
Thomas Lamprecht
8e410f5399 save pveOnlineHelpInfo as const
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-06-06 19:45:49 +02:00
Thomas Lamprecht
cf96251f13 whitespace cleanup
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-06-06 19:45:02 +02:00
Thomas Lamprecht
396e1d03f2 html: use new table-of-contents (toc2) also for individual chapters
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-01-28 18:19:47 +01:00
Thomas Lamprecht
7de8bba68d asciidoc-pve: ignore link targets for non-manpages
To allow linking from to a chapter/section not included in a manpage
allow the manpage link resolver to just return text in a case the
link target text is in fact no manpage.

If the link is a valid one in general will be checked in a lot of
other places, so here we won't run into a regression where a wrong,
non-existing, link does not get detected by the build system.

The particular case I run into problems with this is when linking
from the pveceph chapter to the pve-package-repos, to point to the
(cheph) repos. pve-package-repos is no where included or itself a
manpage, so this checks fails. Even if we say it would make sense to
have it as a manpage, which was my initial solution, we run then into
issues as we have a link to a outside reference, located in
pve-bibliography, which then we probably do not want as manpage.

So in the case where a valid link, which just has no manpage counter
part, is passed to the respective link resolver I just return the
link text as is. An alternative could be to get the link object and
put it in parentheses after the link text, but I'm not to sure about
this so let's for now go the easier route.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2019-02-13 09:57:30 +01:00
Fabian Grünbichler
b965ad63ad export and respect SOURCE_DATE_EPOCH
to improve reproducibility of pve-docs, pve-doc-generator and
pve-doc-mediawiki builds, as well as man pages generated by
pve-doc-generator when called via dpkg-buildpackage.

timestamps embedded in the documentation now always reflect the last changelog
entry of the package to which the documentation belongs (pve-docs for html,
epub and pdf, individual packages for man pages).

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2018-02-22 16:31:08 +01:00
Wolfgang Bumiller
2f0886ca0c asciidoc-pve: include the PID in the temp file prefix
To allow parallel runs of multiple pages including some
common source.
2017-02-06 15:52:23 +01:00
Dietmar Maurer
ae0ad291e1 pve-html.conf: html5 backend with thumbnail support 2016-11-07 18:17:44 +01:00
Dietmar Maurer
de7022fbe9 asciidoc-pve.conf: use extra asciidoc configuration file
We can define PVE related attributes here (will replace attributes.txt).
Install all asciidoc-pve config files to /usr/share/pve-doc-generator/asciidoc
2016-11-07 08:19:04 +01:00
Dietmar Maurer
110ebe8fe1 add code to generate correct footnotes on wiki pages 2016-10-22 10:57:06 +02:00
Dietmar Maurer
dc7c3dd9e3 asciidoc-pve.in: fix warning about undefined value 2016-10-21 11:25:59 +02:00
Dietmar Maurer
7d48940bf0 asciidoc-pve.in: detect and avoid xrefs spanning multiple lines
Because our parser is not smart enough to do it better.
2016-10-21 07:06:36 +02:00
Dietmar Maurer
fd02ab9033 move code from gen-index-includes.pl into asciidoc-pve.in 2016-10-21 06:34:01 +02:00
Dietmar Maurer
d77477d76a asciidoc-pve.in: use new mediawiki.conf to render wiki pages 2016-10-19 08:15:16 +02:00
Dietmar Maurer
8faad89e86 use the html5 backend for asciidoc 2016-10-18 13:31:38 +02:00
Dietmar Maurer
fe38a7e7da use fixed output file mapping 2016-10-14 05:59:05 +02:00
Dietmar Maurer
a297b96efb asciidoc-pve.in: add code to auto generate online help data
We include that in the extjs code for the GUI.
2016-10-13 10:37:23 +02:00
Dietmar Maurer
b2a47ab2b5 asciidoc-pve.in: define revdate/revnumber for all backends 2016-10-12 11:57:46 +02:00
Dietmar Maurer
dd284d2569 asciidoc-pve.in: implement new command print-links-json
prints/stores information about defined blockids with titles/subtitles.
We can use this for the GUI.
2016-10-12 11:52:13 +02:00
Dietmar Maurer
4ff677c9d7 use asciidoc-pve whenever possible
So that we have correct links.
2016-10-12 06:35:30 +02:00
Dietmar Maurer
94a60df796 asciidoc-pve: be quiet by default 2016-10-11 16:53:37 +02:00
Dietmar Maurer
034b35c838 asciidoc-pve: cleanup temporary files 2016-10-11 16:48:31 +02:00
Dietmar Maurer
c38115e910 asciidoc-pve.in: implement commands to generate man pages 2016-10-11 10:28:30 +02:00
Dietmar Maurer
a22a4a80ad asciidoc-pve.in: cleanup for code reuse 2016-10-10 10:42:14 +02:00
Dietmar Maurer
17d8be0cbf factor out cleanup method 2016-10-10 10:18:56 +02:00
Dietmar Maurer
b489b02c74 new file pve-docs-mediawiki-import.in
And use auto-generated data from link-refs.json.

Also avoid strange file names.
2016-10-10 09:16:19 +02:00
Dietmar Maurer
508e00124c make sure we have a text for all xrefs 2016-10-09 08:01:49 +02:00
Dietmar Maurer
a16bf08ef3 support xref using <<>> syntax 2016-10-08 14:09:45 +02:00
Dietmar Maurer
459308313d support reftext for block IDs 2016-10-08 13:41:31 +02:00
Dietmar Maurer
835dd63b03 asciidoc-pve.in: add some real functionality 2016-10-08 13:39:59 +02:00
Dietmar Maurer
aa99b34966 add helper to correctly resolve links
just a start, not ready to use ...
2016-10-06 17:29:03 +02:00