From c65bf2d134dc1a278a3582df738c31b3acdb2d10 Mon Sep 17 00:00:00 2001 From: Boyan Karatotev Date: Thu, 27 Oct 2022 15:12:36 +0100 Subject: [PATCH] docs: add top level section numbering Top level sections are not numbered. Adding numbers makes referring to sections easier. For example the Maintainers page changes from "about/3.1" to simply "1.3.1". Signed-off-by: Boyan Karatotev Change-Id: If90a18ee8d6a6858d58f0687f31ea62b69399e04 --- docs/about/index.rst | 1 - docs/components/index.rst | 1 - docs/design/index.rst | 1 - docs/design_documents/index.rst | 1 - docs/getting_started/index.rst | 1 - docs/index.rst | 2 +- docs/perf/index.rst | 1 - docs/plat/index.rst | 1 - docs/process/index.rst | 1 - docs/security_advisories/index.rst | 1 - docs/threat_model/index.rst | 1 - 11 files changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/about/index.rst b/docs/about/index.rst index 3a102668c..06973ef16 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -4,7 +4,6 @@ About .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: features release-information diff --git a/docs/components/index.rst b/docs/components/index.rst index 0972a68e0..30d80fcdd 100644 --- a/docs/components/index.rst +++ b/docs/components/index.rst @@ -4,7 +4,6 @@ Components .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: spd/index activity-monitors diff --git a/docs/design/index.rst b/docs/design/index.rst index e3b8f7429..17ef75611 100644 --- a/docs/design/index.rst +++ b/docs/design/index.rst @@ -4,7 +4,6 @@ System Design .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: alt-boot-flows auth-framework diff --git a/docs/design_documents/index.rst b/docs/design_documents/index.rst index 765efe6c3..3e20c07ca 100644 --- a/docs/design_documents/index.rst +++ b/docs/design_documents/index.rst @@ -4,7 +4,6 @@ Design Documents .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: cmake_framework context_mgmt_rework diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 717130398..3fbf48dca 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -4,7 +4,6 @@ Getting Started .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: prerequisites docs-build diff --git a/docs/index.rst b/docs/index.rst index edc2535a4..386019943 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ Trusted Firmware-A Documentation .. toctree:: :maxdepth: 1 - :hidden: + :numbered: Home about/index diff --git a/docs/perf/index.rst b/docs/perf/index.rst index 1482b80f6..bccad006c 100644 --- a/docs/perf/index.rst +++ b/docs/perf/index.rst @@ -4,7 +4,6 @@ Performance & Testing .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: psci-performance-juno tsp diff --git a/docs/plat/index.rst b/docs/plat/index.rst index 3eac6f7a5..a4e206780 100644 --- a/docs/plat/index.rst +++ b/docs/plat/index.rst @@ -4,7 +4,6 @@ Platform Ports .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: :hidden: allwinner diff --git a/docs/process/index.rst b/docs/process/index.rst index 422ab2869..7914a4e27 100644 --- a/docs/process/index.rst +++ b/docs/process/index.rst @@ -4,7 +4,6 @@ Processes & Policies .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: security platform-ports-policy diff --git a/docs/security_advisories/index.rst b/docs/security_advisories/index.rst index 887b06a55..b80ba34d3 100644 --- a/docs/security_advisories/index.rst +++ b/docs/security_advisories/index.rst @@ -4,7 +4,6 @@ Security Advisories .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: security-advisory-tfv-1.rst security-advisory-tfv-2.rst diff --git a/docs/threat_model/index.rst b/docs/threat_model/index.rst index 9d84f5b92..ad8b82ac0 100644 --- a/docs/threat_model/index.rst +++ b/docs/threat_model/index.rst @@ -11,7 +11,6 @@ based on the data flow diagram and potential threat mitigations. .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: threat_model threat_model_spm -- 2.39.5