DistroKit Mailinglist
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: distrokit@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [DistroKit] [PATCH 1/2] doc: use layered documentation instead of overwriting doc/guru.rsto
Date: Wed, 10 May 2023 15:39:15 +0200	[thread overview]
Message-ID: <20230510133915.1724757-1-rhi@pengutronix.de> (raw)

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 <rhi@pengutronix.de>
---
 doc/guru.rst                                   | 17 -----------------
 doc/{index.rst => index-layer-1-distrokit.rst} |  2 --
 2 files changed, 19 deletions(-)
 delete mode 100644 doc/guru.rst
 rename doc/{index.rst => index-layer-1-distrokit.rst} (87%)

diff --git a/doc/guru.rst b/doc/guru.rst
deleted file mode 100644
index 19294647df49..000000000000
--- 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.rst b/doc/index-layer-1-distrokit.rst
similarity index 87%
rename from doc/index.rst
rename to doc/index-layer-1-distrokit.rst
index f76f48c1a059..751ef3fb8d2f 100644
--- a/doc/index.rst
+++ b/doc/index-layer-1-distrokit.rst
@@ -3,12 +3,10 @@ Welcome to DistroKit
 
 .. toctree::
    :glob:
-   :numbered:
    :maxdepth: 2
 
    intro
    hardware
-   guru
    testing
 
 * :ref:`search`
-- 
2.39.2




             reply	other threads:[~2023-05-10 13:39 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-10 13:39 Roland Hieber [this message]
2023-05-10 13:39 ` [DistroKit] [PATCH 2/2] doc: intro: link to license and Git history Roland Hieber
2023-06-20 13:03   ` Robert Schwebel
2023-06-20 13:03 ` [DistroKit] [PATCH 1/2] doc: use layered documentation instead of overwriting doc/guru.rsto Robert Schwebel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230510133915.1724757-1-rhi@pengutronix.de \
    --to=rhi@pengutronix.de \
    --cc=distrokit@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox