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

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

[Yann Dirson]

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

 .gitignore   | 1 +
 docs/conf.py | 1 +
 2 files changed, 2 insertions(+)

-- 
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech

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

[Yann Dirson]

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

diff --git a/docs/conf.py b/docs/conf.py
index 5d2e979449..84bec024e7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -21,6 +21,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 import sphinx
+import sys
 
 project = u'Xen'
 copyright = u'2019-%Y, The Xen development community'
-- 
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech

[XEN PATCH 2/2] docs/sphinx: gitignore generated files

[Yann Dirson]

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

diff --git a/.gitignore b/.gitignore
index 25484a8fd8..404590c36a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -62,6 +62,7 @@ docs/man5/
 docs/man7/
 docs/man8/
 docs/pdf/
+docs/sphinx/
 docs/txt/
 extras/
 install/*
-- 
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech

Re: [XEN PATCH 1/2] docs/sphinx: import sys for error reporting

[Andrew Cooper]

On 15/01/2025 12:01 pm, Yann Dirson wrote:
> Signed-off-by: Yann Dirson <yann.dirson@vates.tech>
> ---
>  docs/conf.py | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/docs/conf.py b/docs/conf.py
> index 5d2e979449..84bec024e7 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -21,6 +21,7 @@
>  # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
>  
>  import sphinx
> +import sys
>  
>  project = u'Xen'
>  copyright = u'2019-%Y, The Xen development community'

Oh, that's awkward.  Older sphinx must have had sys in context, because
it did work when I initially added that check.

Any chance this can go up above the "Path setup" section, and drop the
commented out line?

~Andrew

Re: [XEN PATCH 2/2] docs/sphinx: gitignore generated files

[Andrew Cooper]

On 15/01/2025 12:01 pm, Yann Dirson wrote:
> Signed-off-by: Yann Dirson <yann.dirson@vates.tech>
> ---
>  .gitignore | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/.gitignore b/.gitignore
> index 25484a8fd8..404590c36a 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -62,6 +62,7 @@ docs/man5/
>  docs/man7/
>  docs/man8/
>  docs/pdf/
> +docs/sphinx/
>  docs/txt/
>  extras/
>  install/*

Thanks, although we're transitioning to per-dir .gitignore files.

Can this move into docs/.gitignore and become sphinx/ as the pattern?

If you fancy fixing all of them, that would be excellent too.  See c/s
0a15b7695bd983f "tools/ocaml: Rationalise .gitignore" as an example.

~Andrew