Skip to contentSkip to conversation

trivial improvements to sphinx doc tooling

PATCH Superseded Yann Dirson 2 participants 5 messages Jan 15, 2025

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover trivial improvements to sphinx doc tooling

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(+)
Signature · 9 lines
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech
#3 lore raw

PATCH 2/2 docs/sphinx: gitignore generated files

---
 .gitignore | 1 +
 1 file changed, 1 insertion(+)
.gitignore +1 -0
index 25484a8fd8..404590c36a 100644
@@ -62,6 +62,7 @@ docs/man5/
 docs/man7/
 docs/man8/
 docs/pdf/
+docs/sphinx/
 docs/txt/
 extras/
 install/*
Signature · 9 lines
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech
#1 lore raw

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

In reply to Yann Dirson
---
 docs/conf.py | 1 +
 1 file changed, 1 insertion(+)
docs/conf.py +1 -0
index 5d2e979449..84bec024e7 100644
@@ -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'
Signature · 9 lines
2.39.5



Yann Dirson | Vates Platform Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech
#2 lore raw

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

Quoted 10 lines · Yann Dirson
---
 docs/conf.py | 1 +
 1 file changed, 1 insertion(+)
docs/conf.py +0 -0
index 5d2e979449..84bec024e7 100644

docs/conf.py line 27

Quoted 7 lines
docs/conf.py +1 -0
@@ -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

#4 lore raw

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

In reply to Yann Dirson
Quoted 10 lines · Yann Dirson
---
 .gitignore | 1 +
 1 file changed, 1 insertion(+)
.gitignore +0 -0
index 25484a8fd8..404590c36a 100644

.gitignore docs/man5/ · line 68

Quoted 7 lines
.gitignore +1 -0
@@ -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