fixup pdf build

Signed-off-by: Christian Goll <cgoll@suse.com>
This commit is contained in:
Christian Goll
2025-03-03 11:58:43 +01:00
committed by Jonathon Anderson
parent a58b48fa52
commit d256d15c20
5 changed files with 11 additions and 4 deletions

View File

@@ -9,11 +9,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
### Fixed
- Fixed panic in warewulfd if node netdev is only defined in a profile. #1817
- Replaced unreadable >= character external sphinx module for pdf doc build.
### Changed
- Update GitHub actions to build aarch64 artifacts.
### Removed
- Removed "Auto generated by" tag from generated docs.
## v4.6.0, 2025-03-02
### Added

View File

@@ -89,7 +89,7 @@ reference: wwctl
./wwctl --emptyconf genconfig reference userdocs/reference/
latexpdf: reference
make -C userdocs latexpdf
SPHINXOPTS='-t pdf -D release=$(VERSION)' make -C userdocs latexpdf
##@ Development

View File

@@ -11,6 +11,7 @@ func CobraRunE(cmd *cobra.Command, args []string) (err error) {
linkHandler := func(name, ref string) string {
return fmt.Sprintf(":ref:`%s <%s>`", name, ref)
}
cmd.Parent().Parent().DisableAutoGenTag = true
err = doc.GenReSTTreeCustom(cmd.Parent().Parent(), args[0], func(arg string) string { return "" }, linkHandler)
//err = doc.GenReSTTree(cmd.Parent().Parent(), args[0])
return

View File

@@ -7,7 +7,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'Warewulf User Guide'
copyright = '2024, Warewulf Project Contributors'
copyright = '2025, Warewulf Project Contributors'
author = 'Warewulf Project Contributors'
release = 'main'
@@ -16,8 +16,9 @@ release = 'main'
extensions = [
'sphinx.ext.graphviz',
'sphinx_reredirects',
]
if not tags.has('pdf'):
extensions.append('sphinx_reredirects')
redirects = {
'contents/background': '../getting-started/introduction.html',

View File

@@ -158,7 +158,7 @@ For example, the ``imgextract`` command can be `explicitly enabled`_.
This is the case in the default state of ``build-ipxe.sh``, which enables
support for ZLIB and GZIP archive image formats.
Configuring Warewulf ( v4.5.0)
Configuring Warewulf (>= v4.5.0)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In Warewulf v4.5.0, Warewulf can be configured to use these files using the