[gentoo-commits] proj/pkgcore/pkgdev:main commit in: doc/

[gentoo-commits] proj/pkgcore/pkgdev:main commit in: doc/

[Arthur Zamarin]

commit:     640c78d7a6392b57a899a7f9417628bd29447610
Author:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
AuthorDate: Sat Oct 15 14:46:29 2022 +0000
Commit:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
CommitDate: Sat Oct 15 14:46:29 2022 +0000
URL:        https://gitweb.gentoo.org/proj/pkgcore/pkgdev.git/commit/?id=640c78d7

doc: fix generating of code when built in PEP517 mode

When in PEP517 mode, the source code is located in a different location,
so use better relative fallback place. Also cleanup a little the code
handling to use pathlib.

Bug: https://bugs.gentoo.org/877189
Signed-off-by: Arthur Zamarin <arthurzam <AT> gentoo.org>

 doc/conf.py | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/doc/conf.py b/doc/conf.py
index 65e2969..7deb456 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -16,13 +16,17 @@
 import os
 import sys
 from importlib import import_module
+from pathlib import Path
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-libdir = os.path.abspath(os.path.join('..', 'build', 'lib'))
-if os.path.exists(libdir):
-    sys.path.insert(0, libdir)
+
+if (src_path := Path(__file__).parent.parent / 'src').is_dir():
+    sys.path.insert(0, str(src_path.resolve()))
+
+if (libdir := Path(__file__).parent.parent / 'build/lib').is_dir():
+    sys.path.insert(0, str(libdir.resolve()))
 
 os.environ['PKGDIST_REPODIR'] = os.path.abspath('..')
 from snakeoil.dist import distutils_extensions as pkgdist
@@ -241,11 +245,9 @@ latex_documents = [
 
 # -- Options for manual page output ---------------------------------------
 
-bin_path = os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), 'bin')
-scripts = os.listdir(bin_path)
-
 generated_man_pages = [
-    (f"{project}.scripts.{s.replace('-', '_')}", s) for s in scripts
+    (f"{project}.scripts.{s.name.replace('-', '_')}", s.name)
+    for s in (Path(__file__).parent.parent / 'bin').iterdir()
 ]
 
 # One entry per manual page. List of tuples

[gentoo-commits] proj/pkgcore/pkgdev:main commit in: doc/

[Arthur Zamarin]

commit:     ba36d58e552d4127674a740058d4ee713e8a0d6b
Author:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
AuthorDate: Fri Dec 30 15:57:49 2022 +0000
Commit:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
CommitDate: Thu Jan  5 16:22:40 2023 +0000
URL:        https://gitweb.gentoo.org/proj/pkgcore/pkgdev.git/commit/?id=ba36d58e

docs: reorganize main toc

Signed-off-by: Arthur Zamarin <arthurzam <AT> gentoo.org>

 doc/index.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/index.rst b/doc/index.rst
index 9391ad2..8570603 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -8,6 +8,13 @@ Contents:
     :maxdepth: 4
 
     man/pkgdev
+    man/pkgdev/commit
+    man/pkgdev/manifest
+    man/pkgdev/mask
+    man/pkgdev/push
+    man/pkgdev/showkw
+    man/pkgdev/tatt
+    man/config
 
 Indices and tables
 ==================

[gentoo-commits] proj/pkgcore/pkgdev:main commit in: doc/

[Arthur Zamarin]

commit:     d1f38963edf29c36d8be897c331aeabb2d9b7a1e
Author:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
AuthorDate: Mon Jan  8 08:40:04 2024 +0000
Commit:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
CommitDate: Mon Jan  8 08:40:04 2024 +0000
URL:        https://gitweb.gentoo.org/proj/pkgcore/pkgdev.git/commit/?id=d1f38963

docs: add some explanation to main page

Signed-off-by: Arthur Zamarin <arthurzam <AT> gentoo.org>

 doc/index.rst | 5 +++++
 doc/news.rst  | 1 +
 2 files changed, 6 insertions(+)

diff --git a/doc/index.rst b/doc/index.rst
index 8fa4ae2..1f8754f 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,6 +1,10 @@
 Welcome to pkgdev's documentation!
 ==================================
 
+``pkgdev`` is collection of tools for Gentoo development, from generating
+commit messages, to pushing commits to the repository, to filing stable
+requests bugs, to testing packages in a special environment.
+
 Contents:
 
 .. toctree::
@@ -16,6 +20,7 @@ Contents:
     man/pkgdev/showkw
     man/pkgdev/tatt
     man/config
+    news
 
 Indices and tables
 ==================

diff --git a/doc/news.rst b/doc/news.rst
new file mode 120000
index 0000000..e013575
--- /dev/null
+++ b/doc/news.rst
@@ -0,0 +1 @@
+../NEWS.rst
\ No newline at end of file

[gentoo-commits] proj/pkgcore/pkgdev:main commit in: doc/

[Arthur Zamarin]

commit:     d1cf9285ec363388ee1809ae5a367c6507c31b83
Author:     Brian Harring <ferringb <AT> gmail <DOT> com>
AuthorDate: Fri Jan 26 19:55:50 2024 +0000
Commit:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
CommitDate: Fri Jan 26 19:55:50 2024 +0000
URL:        https://gitweb.gentoo.org/proj/pkgcore/pkgdev.git/commit/?id=d1cf9285

fix(docs): Add intersphinx_mapping

This fixes any documentation links to the enumerated projects.

Signed-off-by: Brian Harring <ferringb <AT> gmail.com>

 doc/conf.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/conf.py b/doc/conf.py
index 7f042c1..7ef0346 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -324,3 +324,10 @@ epub_exclude_files = ["search.html"]
 
 # If false, no index is generated.
 # epub_use_index = True
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}
+intersphinx_mapping.update(
+    (x, (f"https://pkgcore.github.io/{x}", None)) for x in "pkgcheck pkgcore snakeoil".split()
+)