From 36f1617930c8381b6e748cda5da3eb7227759c08 Mon Sep 17 00:00:00 2001 From: Roland Hieber Date: Wed, 10 May 2023 15:39:15 +0200 Subject: doc: use layered documentation instead of overwriting doc/guru.rsto Since PTXdist 2023.01.0, all files named index-layer-*.rst are included in the main toctree by upstream PTXdist, so there is no need anymore to fork the upstream guru.rst. See the docs for more info. We have to remove the :numbered: argument because the main toctree in the upstream guru.rst is already numbered, otherwise this will generate a warning. Link: https://www.ptxdist.org/doc/daily_work_section.html#integrate-project-specific-documentation-into-the-manual Signed-off-by: Roland Hieber Link: https://lore.barebox.org/20230510133915.1724757-1-rhi@pengutronix.de Signed-off-by: Robert Schwebel --- doc/guru.rst | 17 ----------------- doc/index-layer-1-distrokit.rst | 14 ++++++++++++++ doc/index.rst | 16 ---------------- 3 files changed, 14 insertions(+), 33 deletions(-) delete mode 100644 doc/guru.rst create mode 100644 doc/index-layer-1-distrokit.rst delete mode 100644 doc/index.rst (limited to 'doc') diff --git a/doc/guru.rst b/doc/guru.rst deleted file mode 100644 index 1929464..0000000 --- a/doc/guru.rst +++ /dev/null @@ -1,17 +0,0 @@ -Welcome to the PTXdist Universe -=============================== - -.. toctree:: - :glob: - :maxdepth: 3 - - welcome - environment - user_manual_section - dev_manual - ref_manual - daily_work_section - contributing - getting_help - faq - diff --git a/doc/index-layer-1-distrokit.rst b/doc/index-layer-1-distrokit.rst new file mode 100644 index 0000000..751ef3f --- /dev/null +++ b/doc/index-layer-1-distrokit.rst @@ -0,0 +1,14 @@ +Welcome to DistroKit +==================== + +.. toctree:: + :glob: + :maxdepth: 2 + + intro + hardware + testing + +* :ref:`search` +* :ref:`genindex` + diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index f76f48c..0000000 --- a/doc/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -Welcome to DistroKit -==================== - -.. toctree:: - :glob: - :numbered: - :maxdepth: 2 - - intro - hardware - guru - testing - -* :ref:`search` -* :ref:`genindex` - -- cgit v1.2.3