trivial improvements to sphinx doc tooling
PATCH v2 2/3 docs: rationalise .gitignore
In reply to Yann DirsonNote I did not transplant the patterns under doc/txt/ (since the whole dir is ignored already), and adjusted sort order to be fully alphabetical.
--- .gitignore | 17 ----------------- docs/.gitignore | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 17 deletions(-) create mode 100644 docs/.gitignore
.gitignore +0 -17
@@ -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
docs/.gitignore new file +14 -0
@@ -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/
Signature · 9 lines
2.39.5 Yann Dirson | Vates Platform Developer XCP-ng & Xen Orchestra - Vates solutions web: https://vates.tech
PATCH v2 3/3 docs/sphinx: gitignore generated files
In reply to Yann Dirson--- docs/.gitignore | 1 + 1 file changed, 1 insertion(+)
docs/.gitignore +1 -0
@@ -10,5 +10,6 @@ /man7/ /man8/ /pdf/ +/sphinx/ /tmp.* /txt/
Signature · 9 lines
2.39.5 Yann Dirson | Vates Platform Developer XCP-ng & Xen Orchestra - Vates solutions web: https://vates.tech
v2 cover trivial improvements to sphinx doc tooling
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
Signature · 9 lines
2.39.5 Yann Dirson | Vates Platform Developer XCP-ng & Xen Orchestra - Vates solutions web: https://vates.tech
PATCH v2 1/3 docs/sphinx: import sys for error reporting
--- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
docs/conf.py +2 -1
@@ -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('.'))
Signature · 9 lines
2.39.5 Yann Dirson | Vates Platform Developer XCP-ng & Xen Orchestra - Vates solutions web: https://vates.tech
Quoted 9 lines · Yann Dirson
changes:
v2:
* move import up and adjust "path setup" instructions
* new patch for .gitignore rationalisationYann Dirson (3):
docs/sphinx: import sys for error reporting
docs: rationalise .gitignore
docs/sphinx: gitignore generated files
Re: [XEN PATCH v2 2/3] docs: rationalise .gitignore
In reply to Yann DirsonQuoted 10 lines · Yann Dirson
docs/.gitignore new file +4
-0@@ -0,0 +1,14 @@ +/figs/*.png +/html/ +/man/xl.cfg.5.pod +/man/xl-disk-configuration.5.pod
docs/.gitignore line 14
Quoted 10 lines
docs/.gitignore new file +10
-0+/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