diff mbox series

docs/sphinx: Fix FUSA indexing

Message ID 20241122164908.3240056-1-andrew.cooper3@citrix.com (mailing list archive)
State New
Headers show
Series docs/sphinx: Fix FUSA indexing | expand

Commit Message

Andrew Cooper Nov. 22, 2024, 4:49 p.m. UTC
Sphinx complains:

  docs/fusa/index.rst:6: WARNING: toctree contains reference to nonexisting document 'fusa/reqs'
  docs/fusa/reqs/index.rst:6: WARNING: toctree contains reference to nonexisting document 'fusa/reqs/market-reqs'
  docs/fusa/reqs/index.rst:6: WARNING: toctree contains reference to nonexisting document 'fusa/reqs/product-reqs'
  docs/fusa/reqs/index.rst:6: WARNING: toctree contains reference to nonexisting document 'fusa/reqs/design-reqs/arm64'

  docs/fusa/index.rst: WARNING: document isn't included in any toctree
  docs/fusa/reqs/design-reqs/arm64/generic-timer.rst: WARNING: document isn't included in any toctree
  docs/fusa/reqs/design-reqs/arm64/sbsa-uart.rst: WARNING: document isn't included in any toctree
  docs/fusa/reqs/index.rst: WARNING: document isn't included in any toctree
  docs/fusa/reqs/market-reqs/reqs.rst: WARNING: document isn't included in any toctree
  docs/fusa/reqs/product-reqs/arm64/reqs.rst: WARNING: document isn't included in any toctree

Fix the toctrees.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: Jan Beulich <JBeulich@suse.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Julien Grall <julien@xen.org>

I'm also going to prioritise getting a docs test in Gitlab CI.
---
 docs/fusa/index.rst      | 2 +-
 docs/fusa/reqs/index.rst | 7 ++++---
 docs/index.rst           | 1 +
 3 files changed, 6 insertions(+), 4 deletions(-)


base-commit: c0bf8816c9e2a4701c925d8b23abfda5990a0087
prerequisite-patch-id: c6d7da051cd408c9f38d32ecdd24807bfbe619d1
diff mbox series

Patch

diff --git a/docs/fusa/index.rst b/docs/fusa/index.rst
index 13bf4e8e23f1..5f1e8acfc429 100644
--- a/docs/fusa/index.rst
+++ b/docs/fusa/index.rst
@@ -6,4 +6,4 @@  Functional Safety documentation
 .. toctree::
    :maxdepth: 2
 
-   reqs
+   reqs/index
diff --git a/docs/fusa/reqs/index.rst b/docs/fusa/reqs/index.rst
index 183f183b1f8c..8a4dae6fb249 100644
--- a/docs/fusa/reqs/index.rst
+++ b/docs/fusa/reqs/index.rst
@@ -7,6 +7,7 @@  Requirements documentation
    :maxdepth: 2
 
    intro
-   market-reqs
-   product-reqs
-   design-reqs/arm64
+   market-reqs/reqs
+   product-reqs/arm64/reqs
+   design-reqs/arm64/generic-timer
+   design-reqs/arm64/sbsa-uart
diff --git a/docs/index.rst b/docs/index.rst
index ab051a0f3833..1d44796d7296 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -65,6 +65,7 @@  Documents in need of some rearranging.
    designs/launch/hyperlaunch-devicetree
    misc/xen-makefiles/makefiles
    misra/index
+   fusa/index
 
 
 Miscellanea