Troubleshooting Antora build errors
-
Netlify build error:
Duplicate nav in nightly@home: modules/ROOT/nav.adoc
-
This probably means that there are two branches of the same repository defined in the Antora playbook, that have the same version set. They both supply a
nav.adoc
file for the same component and version, and Antora doesn’t know which one to pick. Make sure that the release branches have the correct version set in theirantora.yml
files and also make sure that themain
branch is still set tonightly
.
-
-
An
xref
orinclude
in thehome
component is not found (starting withxref:home…
)-
If the page containing the
xref
is also in thehome
component, do not include the component name in thexref
. Read thexref
documentation. Creating a reference to a page and specifying a component without a version means that the link is pointing to the latest version. This is usually not what you want! Omitting the component entirely will instead link to the target page within the same version as the page resides in.
-
-
Other
xref
andinclude
issues-
Familiarize yourself with the
xref
documentation which explains the syntax in great detail. Unfortunately the xref syntax is a common place to make mistakes, and it is easy to accidently link to the wrong place.
-