[XEN PATCH v2 0/3] trivial improvements to sphinx doc tooling

[XEN PATCH v2 0/3] trivial improvements to sphinx doc tooling

[Yann Dirson]

changes:
v2:
* move import up and adjust "path setup" instructions
* new patch for .gitignore rationalisation

Yann Dirson (3):
  docs/sphinx: import sys for error reporting
  docs: rationalise .gitignore
  docs/sphinx: gitignore generated files

 .gitignore      | 17 -----------------
 docs/.gitignore | 15 +++++++++++++++
 docs/conf.py    |  3 ++-
 3 files changed, 17 insertions(+), 18 deletions(-)
 create mode 100644 docs/.gitignore

-- 
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech

[XEN PATCH v2 2/3] docs: rationalise .gitignore

[Yann Dirson]

Note I did not transplant the patterns under doc/txt/ (since the whole
dir is ignored already), and adjusted sort order to be fully
alphabetical.

Signed-off-by: Yann Dirson <yann.dirson@vates.tech>
---
 .gitignore      | 17 -----------------
 docs/.gitignore | 14 ++++++++++++++
 2 files changed, 14 insertions(+), 17 deletions(-)
 create mode 100644 docs/.gitignore

diff --git a/.gitignore b/.gitignore
index 25484a8fd8..53f5df0003 100644
--- a/.gitignore
+++ b/.gitignore
@@ -50,19 +50,6 @@ config/Toplevel.mk
 config/Paths.mk
 
 dist/*
-docs/tmp.*
-docs/html/
-docs/man/xl.cfg.5.pod
-docs/man/xl-disk-configuration.5.pod
-docs/man/xl-network-configuration.5.pod
-docs/man/xl.1.pod
-docs/man/xl.conf.5.pod
-docs/man1/
-docs/man5/
-docs/man7/
-docs/man8/
-docs/pdf/
-docs/txt/
 extras/
 install/*
 
@@ -302,7 +289,3 @@ tools/debugger/kdd/kdd
 tools/firmware/etherboot/ipxe.tar.gz
 tools/firmware/etherboot/ipxe/
 tools/xl/xl
-
-docs/txt/misc/*.txt
-docs/txt/man/*.txt
-docs/figs/*.png
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000000..0727c6d7cf
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,14 @@
+/figs/*.png
+/html/
+/man/xl.cfg.5.pod
+/man/xl-disk-configuration.5.pod
+/man/xl-network-configuration.5.pod
+/man/xl.1.pod
+/man/xl.conf.5.pod
+/man1/
+/man5/
+/man7/
+/man8/
+/pdf/
+/tmp.*
+/txt/
-- 
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech

Re: [XEN PATCH v2 2/3] docs: rationalise .gitignore

[Andrew Cooper]

On 15/01/2025 12:27 pm, Yann Dirson wrote:
> diff --git a/docs/.gitignore b/docs/.gitignore
> new file mode 100644
> index 0000000000..0727c6d7cf
> --- /dev/null
> +++ b/docs/.gitignore
> @@ -0,0 +1,14 @@
> +/figs/*.png
> +/html/
> +/man/xl.cfg.5.pod
> +/man/xl-disk-configuration.5.pod
> +/man/xl-network-configuration.5.pod
> +/man/xl.1.pod
> +/man/xl.conf.5.pod
> +/man1/
> +/man5/
> +/man7/
> +/man8/
> +/pdf/
> +/tmp.*
> +/txt/

I'm reasonably sure tmp.* is stale now.  I can't find anything that
references it now.

Also, the manpages ought to be /man[1-9]/ to use a single pattern and
cover all reasonable eventualities.

I can fix these on commit.

~Andrew

[XEN PATCH v2 3/3] docs/sphinx: gitignore generated files

[Yann Dirson]

Signed-off-by: Yann Dirson <yann.dirson@vates.tech>
---
 docs/.gitignore | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/.gitignore b/docs/.gitignore
index 0727c6d7cf..e87b12890a 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -10,5 +10,6 @@
 /man7/
 /man8/
 /pdf/
+/sphinx/
 /tmp.*
 /txt/
-- 
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech

[XEN PATCH v2 1/3] docs/sphinx: import sys for error reporting

[Yann Dirson]

Signed-off-by: Yann Dirson <yann.dirson@vates.tech>
---
 docs/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index 5d2e979449..2fb8bafe65 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -6,6 +6,8 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import sys
+
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -13,7 +15,6 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 # import os
-# import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
 
-- 
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech

Re: [XEN PATCH v2 0/3] trivial improvements to sphinx doc tooling

[Andrew Cooper]

On 15/01/2025 12:27 pm, Yann Dirson wrote:
> changes:
> v2:
> * move import up and adjust "path setup" instructions
> * new patch for .gitignore rationalisation
>
> Yann Dirson (3):
>   docs/sphinx: import sys for error reporting
>   docs: rationalise .gitignore
>   docs/sphinx: gitignore generated files

Acked-by: Andrew Cooper <andrew.cooper3@citrix.com>