[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[xen master] docs/sphinx: Fix FUSA indexing



commit 233f03dd83e29c6ed22a902c19da8e60dad2c02d
Author:     Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
AuthorDate: Fri Nov 22 16:34:20 2024 +0000
Commit:     Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
CommitDate: Mon Nov 25 13:44:56 2024 +0000

    docs/sphinx: Fix FUSA indexing
    
    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@xxxxxxxxxx>
    Reviewed-by: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>
---
 docs/fusa/index.rst      | 2 +-
 docs/fusa/reqs/index.rst | 7 ++++---
 docs/index.rst           | 1 +
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/docs/fusa/index.rst b/docs/fusa/index.rst
index 13bf4e8e23..5f1e8acfc4 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 183f183b1f..8a4dae6fb2 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 ab051a0f38..1d44796d72 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
--
generated by git-patchbot for /home/xen/git/xen.git#master



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.