[DistroKit] [PATCH 1/2] doc: use layered documentation instead of overwriting doc/guru.rsto

[DistroKit] [PATCH 1/2] doc: use layered documentation instead of overwriting doc/guru.rsto

[Roland Hieber]

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

[DistroKit] [PATCH 2/2] doc: intro: link to license and Git history

[Roland Hieber]

For the people who only have a tarball of the DistroKit source, the
version history is not included, so link to it. Also link to the full
license to make it easier to find when reading the HTML version.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 doc/intro.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/doc/intro.rst b/doc/intro.rst
index 2d4ec2f71266..d07a238808f6 100644
--- a/doc/intro.rst
+++ b/doc/intro.rst
@@ -138,5 +138,8 @@ License
 Copyright (C) 2020 Pengutronix and individual contributors
 
 DistroKit is licensed under the GNU General Public License, version 2.0.
-See the file named LICENSE in the root directory of this project for the full
-license terms, and the version control history for contributor information.
+See the file named `LICENSE`_ in the root directory of this project for the full
+license terms, and the `version control history`_ for contributor information.
+
+.. _LICENSE: https://git.pengutronix.de/cgit/DistroKit/tree/LICENSE
+.. _version control history: https://git.pengutronix.de/cgit/DistroKit/log
-- 
2.39.2

Re: [DistroKit] [PATCH 1/2] doc: use layered documentation instead of overwriting doc/guru.rsto

[Robert Schwebel]

On Wed, May 10, 2023 at 03:39:15PM +0200, Roland Hieber wrote:
> 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%)

Applied to next.

rsc
-- 
Pengutronix e.K.                           | Dipl.-Ing. Robert Schwebel  |
Steuerwalder Str. 21                       | https://www.pengutronix.de/ |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-9    |

Re: [DistroKit] [PATCH 2/2] doc: intro: link to license and Git history

[Robert Schwebel]

On Wed, May 10, 2023 at 03:39:17PM +0200, Roland Hieber wrote:
> For the people who only have a tarball of the DistroKit source, the
> version history is not included, so link to it. Also link to the full
> license to make it easier to find when reading the HTML version.
> 
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> ---
>  doc/intro.rst | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/intro.rst b/doc/intro.rst
> index 2d4ec2f71266..d07a238808f6 100644
> --- a/doc/intro.rst
> +++ b/doc/intro.rst
> @@ -138,5 +138,8 @@ License
>  Copyright (C) 2020 Pengutronix and individual contributors
>  
>  DistroKit is licensed under the GNU General Public License, version 2.0.
> -See the file named LICENSE in the root directory of this project for the full
> -license terms, and the version control history for contributor information.
> +See the file named `LICENSE`_ in the root directory of this project for the full
> +license terms, and the `version control history`_ for contributor information.
> +
> +.. _LICENSE: https://git.pengutronix.de/cgit/DistroKit/tree/LICENSE
> +.. _version control history: https://git.pengutronix.de/cgit/DistroKit/log
> -- 
> 2.39.2

Applied to next.

rsc
-- 
Pengutronix e.K.                           | Dipl.-Ing. Robert Schwebel  |
Steuerwalder Str. 21                       | https://www.pengutronix.de/ |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-9    |