[ptxdist] [PATCH] doc: ref_manual: break up large HTML file into smaller chapters

[ptxdist] [PATCH] doc: ref_manual: break up large HTML file into smaller chapters

[Roland Hieber]

This chapter is getting very long and could also profit from an extra
table of contents.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 doc/{ref_make_macros.inc => ref_make_macros.rst}     |  0
 ...ref_make_variables.inc => ref_make_variables.rst} |  0
 doc/ref_manual.rst                                   | 12 ++++++------
 doc/{ref_parameter.inc => ref_parameter.rst}         |  0
 ...rule_file_layout.inc => ref_rule_file_layout.rst} |  0
 5 files changed, 6 insertions(+), 6 deletions(-)
 rename doc/{ref_make_macros.inc => ref_make_macros.rst} (100%)
 rename doc/{ref_make_variables.inc => ref_make_variables.rst} (100%)
 rename doc/{ref_parameter.inc => ref_parameter.rst} (100%)
 rename doc/{ref_rule_file_layout.inc => ref_rule_file_layout.rst} (100%)

diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.rst
similarity index 100%
rename from doc/ref_make_macros.inc
rename to doc/ref_make_macros.rst
diff --git a/doc/ref_make_variables.inc b/doc/ref_make_variables.rst
similarity index 100%
rename from doc/ref_make_variables.inc
rename to doc/ref_make_variables.rst
diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
index 44d031010e72..850d7239914b 100644
--- a/doc/ref_manual.rst
+++ b/doc/ref_manual.rst
@@ -1,9 +1,9 @@
 PTXdist Reference
 =================
 
-.. include:: ref_make_variables.inc
-.. include:: ref_make_macros.inc
-.. include:: ref_rule_file_layout.inc
-
-
-.. include:: ref_parameter.inc
+.. toctree::
+   
+   ref_make_variables
+   ref_make_macros
+   ref_rule_file_layout
+   ref_parameter
diff --git a/doc/ref_parameter.inc b/doc/ref_parameter.rst
similarity index 100%
rename from doc/ref_parameter.inc
rename to doc/ref_parameter.rst
diff --git a/doc/ref_rule_file_layout.inc b/doc/ref_rule_file_layout.rst
similarity index 100%
rename from doc/ref_rule_file_layout.inc
rename to doc/ref_rule_file_layout.rst
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de

[ptxdist] [PATCH v2 1/2] doc: ref_manual: move section start into ref_parameter.inc

[Roland Hieber]

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
v2: Oops, this patch was missing in v1.

 doc/ref_manual.rst    | 10 ----------
 doc/ref_parameter.inc | 11 +++++++++++
 2 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
index 6541da3eaa00..44d031010e72 100644
--- a/doc/ref_manual.rst
+++ b/doc/ref_manual.rst
@@ -5,15 +5,5 @@ PTXdist Reference
 .. include:: ref_make_macros.inc
 .. include:: ref_rule_file_layout.inc
 
-.. _ptxdist_parameter_reference:
-
-PTXdist parameter reference
----------------------------
-
-PTXdist is a command line tool, which is basically called as:
-
-.. code-block:: bash
-
-    $  ptxdist <action [args]> [options]
 
 .. include:: ref_parameter.inc
diff --git a/doc/ref_parameter.inc b/doc/ref_parameter.inc
index aaac8956f147..4f5fbbe4ac68 100644
--- a/doc/ref_parameter.inc
+++ b/doc/ref_parameter.inc
@@ -1,3 +1,14 @@
+.. _ptxdist_parameter_reference:
+
+PTXdist parameter reference
+---------------------------
+
+PTXdist is a command line tool, which is basically called as:
+
+.. code-block:: bash
+
+    $  ptxdist <action [args]> [options]
+
 Setup and Project Actions
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de

[ptxdist] [PATCH v2 2/2] doc: ref_manual: break up large HTML file into smaller chapters

[Roland Hieber]

This chapter is getting very long and could also profit from an extra
table of contents.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
v2: no changes

 doc/{ref_make_macros.inc => ref_make_macros.rst}     |  0
 ...ref_make_variables.inc => ref_make_variables.rst} |  0
 doc/ref_manual.rst                                   | 12 ++++++------
 doc/{ref_parameter.inc => ref_parameter.rst}         |  0
 ...rule_file_layout.inc => ref_rule_file_layout.rst} |  0
 5 files changed, 6 insertions(+), 6 deletions(-)
 rename doc/{ref_make_macros.inc => ref_make_macros.rst} (100%)
 rename doc/{ref_make_variables.inc => ref_make_variables.rst} (100%)
 rename doc/{ref_parameter.inc => ref_parameter.rst} (100%)
 rename doc/{ref_rule_file_layout.inc => ref_rule_file_layout.rst} (100%)

diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.rst
similarity index 100%
rename from doc/ref_make_macros.inc
rename to doc/ref_make_macros.rst
diff --git a/doc/ref_make_variables.inc b/doc/ref_make_variables.rst
similarity index 100%
rename from doc/ref_make_variables.inc
rename to doc/ref_make_variables.rst
diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
index 44d031010e72..850d7239914b 100644
--- a/doc/ref_manual.rst
+++ b/doc/ref_manual.rst
@@ -1,9 +1,9 @@
 PTXdist Reference
 =================
 
-.. include:: ref_make_variables.inc
-.. include:: ref_make_macros.inc
-.. include:: ref_rule_file_layout.inc
-
-
-.. include:: ref_parameter.inc
+.. toctree::
+   
+   ref_make_variables
+   ref_make_macros
+   ref_rule_file_layout
+   ref_parameter
diff --git a/doc/ref_parameter.inc b/doc/ref_parameter.rst
similarity index 100%
rename from doc/ref_parameter.inc
rename to doc/ref_parameter.rst
diff --git a/doc/ref_rule_file_layout.inc b/doc/ref_rule_file_layout.rst
similarity index 100%
rename from doc/ref_rule_file_layout.inc
rename to doc/ref_rule_file_layout.rst
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de

Re: [ptxdist] [APPLIED] doc: ref_manual: break up large HTML file into smaller chapters

[Michael Olbrich]

Thanks, applied as 1a8021b722bb3139ef3c9df1e3c465311ed0bba0.

Michael

[sent from post-receive hook]

On Thu, 11 Jun 2020 11:39:40 +0200, Roland Hieber <rhi@pengutronix.de> wrote:
> This chapter is getting very long and could also profit from an extra
> table of contents.
> 
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> Message-Id: <20200604121533.27886-2-rhi@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.rst
> similarity index 100%
> rename from doc/ref_make_macros.inc
> rename to doc/ref_make_macros.rst
> diff --git a/doc/ref_make_variables.inc b/doc/ref_make_variables.rst
> similarity index 100%
> rename from doc/ref_make_variables.inc
> rename to doc/ref_make_variables.rst
> diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
> index 44d031010e72..850d7239914b 100644
> --- a/doc/ref_manual.rst
> +++ b/doc/ref_manual.rst
> @@ -1,9 +1,9 @@
>  PTXdist Reference
>  =================
>  
> -.. include:: ref_make_variables.inc
> -.. include:: ref_make_macros.inc
> -.. include:: ref_rule_file_layout.inc
> -
> -
> -.. include:: ref_parameter.inc
> +.. toctree::
> +   
> +   ref_make_variables
> +   ref_make_macros
> +   ref_rule_file_layout
> +   ref_parameter
> diff --git a/doc/ref_parameter.inc b/doc/ref_parameter.rst
> similarity index 100%
> rename from doc/ref_parameter.inc
> rename to doc/ref_parameter.rst
> diff --git a/doc/ref_rule_file_layout.inc b/doc/ref_rule_file_layout.rst
> similarity index 100%
> rename from doc/ref_rule_file_layout.inc
> rename to doc/ref_rule_file_layout.rst

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de

Re: [ptxdist] [APPLIED] doc: ref_manual: move section start into ref_parameter.inc

[Michael Olbrich]

Thanks, applied as f692ff1bc24523d14ae322e9564b56920bab68ce.

Michael

[sent from post-receive hook]

On Thu, 11 Jun 2020 11:39:39 +0200, Roland Hieber <rhi@pengutronix.de> wrote:
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> Message-Id: <20200604121533.27886-1-rhi@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
> index 6541da3eaa00..44d031010e72 100644
> --- a/doc/ref_manual.rst
> +++ b/doc/ref_manual.rst
> @@ -5,15 +5,5 @@ PTXdist Reference
>  .. include:: ref_make_macros.inc
>  .. include:: ref_rule_file_layout.inc
>  
> -.. _ptxdist_parameter_reference:
> -
> -PTXdist parameter reference
> ----------------------------
> -
> -PTXdist is a command line tool, which is basically called as:
> -
> -.. code-block:: bash
> -
> -    $  ptxdist <action [args]> [options]
>  
>  .. include:: ref_parameter.inc
> diff --git a/doc/ref_parameter.inc b/doc/ref_parameter.inc
> index aaac8956f147..4f5fbbe4ac68 100644
> --- a/doc/ref_parameter.inc
> +++ b/doc/ref_parameter.inc
> @@ -1,3 +1,14 @@
> +.. _ptxdist_parameter_reference:
> +
> +PTXdist parameter reference
> +---------------------------
> +
> +PTXdist is a command line tool, which is basically called as:
> +
> +.. code-block:: bash
> +
> +    $  ptxdist <action [args]> [options]
> +
>  Setup and Project Actions
>  ~~~~~~~~~~~~~~~~~~~~~~~~~
>  

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de