kumquat-buildroot/docs/manual
Yann E. MORIN 6a6a11f64b package/doc-asciidoc: allow docs to request a specific TOC depth
For some documents, we may want a terse or deeper TOC depth. For
example, short documents may want just the level-0 in the TOC, while
longer documents may want depth 1 or 2, or even deeper; also, some
documents may not use the document-title levels [0], only section
levels [1], and so may want to increase the TOC depth.

Additionally, allow per-format depth. For example, split-html has a
single page dedicated to the TOC, so there we may want a deeper TOC,
while on the html output, where the TOC is on the same page as the
whole document, a shorter TOC is preferred.

[0] https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#document-header
[1] https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#section-titles

Signed-off-by: Yann E. MORIN <yann.morin@orange.com>
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
2023-04-10 21:49:22 +02:00
..
adding-board-support.txt
adding-packages-asciidoc.txt package/doc-asciidoc: allow docs to request a specific TOC depth 2023-04-10 21:49:22 +02:00
adding-packages-autotools.txt manual: drop LIBFOO_GETTEXTIZE, add LIBFOO_AUTOPOINT 2023-03-25 21:56:19 +01:00
adding-packages-cargo.txt
adding-packages-cmake.txt
adding-packages-conclusion.txt
adding-packages-directory.txt
adding-packages-generic.txt
adding-packages-gettext.txt
adding-packages-golang.txt
adding-packages-hooks.txt
adding-packages-kconfig.txt
adding-packages-kernel-module.txt
adding-packages-linux-kernel-spec-infra.txt
adding-packages-luarocks.txt
adding-packages-meson.txt
adding-packages-perl.txt
adding-packages-python.txt
adding-packages-qmake.txt
adding-packages-rebar.txt
adding-packages-tips.txt
adding-packages-virtual.txt
adding-packages-waf.txt
adding-packages.txt
advanced.txt
appendix.txt
beyond-buildroot.txt
ccache-support.txt
common-usage.txt
configure-other-components.txt
configure.txt
contribute.txt
customize-configuration.txt
customize-device-permission-tables.txt
customize-directory-structure.txt
customize-outside-br.txt
customize-packages.txt
customize-patches.txt
customize-post-image.txt
customize-quick-guide.txt
customize-rootfs.txt
customize-users-tables.txt
customize.txt
debugging-buildroot.txt
developers.txt
download-infra.txt
download-location.txt
faq-troubleshooting.txt
getting.txt
how-buildroot-works.txt
integration-selinux-support.txt
integration-systemd.txt
integration.txt
introduction.txt
known-issues.txt
legal-notice.txt
make-tips.txt
makedev-syntax.txt
makeusers-syntax.txt
manual.mk
manual.txt
migrating.txt
package-make-target.txt
patch-policy.txt
prerequisite.txt
quickstart.txt
rebuilding-packages.txt
release-engineering.txt
resources.txt
using-buildroot-debugger.txt
using-buildroot-development.txt
using-buildroot-toolchain.txt
writing-rules.txt docs/manual: ditch redundant -f 'rm' flag 2023-03-28 21:36:07 +02:00