Merge 493aca9 into 4e30b3e

.bumpversion.cfg

@@ -3,8 +3,6 @@ current_version = 3.0.1
 commit = True
 tag = True
 
-[bumpversion:file:__pkginfo__.py]
-
 [bumpversion:file:README.rst]
 
 [bumpversion:file:doc-source/index.rst]
@@ -18,6 +16,9 @@ replace = : str = "{new_version}"
 
 [bumpversion:file:pyproject.toml]
 
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
 [bumpversion:file:setup.cfg]
 search = version = {current_version}
 replace = version = {new_version}

.github/stale.yml

@@ -28,7 +28,7 @@ exemptMilestones: false
 exemptAssignees: false
 
 # Label to use when marking as stale
-staleLabel: wontfix
+staleLabel: stale
 
 # Comment to post when marking as stale. Set to `false` to disable
 markComment: >

.github/workflows/docs_test_action.yml

@@ -2,7 +2,8 @@
 ---
 name: "Docs Check"
 on:
-  - push
+  push:
+  pull_request:
 
 permissions:
   contents: read

.github/workflows/flake8.yml

@@ -4,6 +4,7 @@ name: Flake8
 
 on:
   push:
+  pull_request:
 
 permissions:
   contents: read

.github/workflows/mypy.yml

@@ -4,6 +4,7 @@ name: mypy
 
 on:
   push:
+  pull_request:
 
 permissions:
   contents: read

.github/workflows/python_ci.yml

@@ -4,6 +4,7 @@ name: Windows
 
 on:
   push:
+  pull_request:
 
 permissions:
   actions: write

.github/workflows/python_ci_linux.yml

@@ -4,6 +4,7 @@ name: Linux
 
 on:
   push:
+  pull_request:
 
 permissions:
   actions: write

.github/workflows/python_ci_macos.yml

@@ -4,6 +4,7 @@ name: macOS
 
 on:
   push:
+  pull_request:
 
 permissions:
   actions: write

.pre-commit-config.yaml

@@ -4,6 +4,11 @@
 exclude: ^$
 
 repos:
+ - repo: https://github.com/repo-helper/pyproject-parser
+   rev: v0.3.0
+   hooks:
+    - id: reformat-pyproject
+
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v3.4.0
    hooks:
@@ -41,7 +46,7 @@ repos:
       files: ^ytools/.*\.py$
 
  - repo: https://github.com/domdfcoding/flake2lint
-   rev: v0.4.0
+   rev: v0.4.1
    hooks:
     - id: flake2lint
 
@@ -68,7 +73,7 @@ repos:
     - id: forbid-crlf
 
  - repo: https://github.com/repo-helper/formate
-   rev: v0.4.4
+   rev: v0.4.9
    hooks:
     - id: formate
       exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$

__pkginfo__.py

@@ -11,10 +11,6 @@
 # This script based on https://github.com/rocky/python-uncompyle6/blob/master/__pkginfo__.py
 #
 
-__all__ = [
-		"__version__",
-		"extras_require",
-		]
+__all__ = ["extras_require"]
 
-__version__ = "3.0.1"
 extras_require = {}

doc-source/conf.py

@@ -60,5 +60,13 @@
 		}
 
 latex_elements = {
-		"fncychap": "\\usepackage[Bjarne]{fncychap}\n\\ChNameAsIs\n\\ChTitleAsIs\n",
+		"printindex": "\\begin{flushleft}\n\\printindex\n\\end{flushleft}",
+		"tableofcontents": "\\pdfbookmark[0]{\\contentsname}{toc}\\sphinxtableofcontents",
 		}
+
+
+def setup(app):
+	# 3rd party
+	from sphinx_toolbox.latex import better_header_layout
+
+	app.connect("config-inited", lambda app, config: better_header_layout(config))

doc-source/index.rst

@@ -5,6 +5,7 @@ ytools3
 .. start short_desc
 
 .. documentation-summary::
+	:meta:
 
 .. end short_desc
 
@@ -173,6 +174,12 @@ Installation
 	Source
 
 
+.. sidebar-links::
+	:caption: Links
+	:github:
+	:pypi: ytools3
+
+
 .. start links
 
 .. only:: html

doc-source/requirements.txt

@@ -12,7 +12,7 @@ sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
 sphinx-pyproject>=0.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=2.9.0
+sphinx-toolbox>=2.10.0
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
 tabulate>=0.8.7

pyproject.toml

@@ -40,12 +40,6 @@ Documentation = "https://ytools3.readthedocs.io/en/latest"
 [project.scripts]
 ytools = "ytools.__main__:main"
 
-[tool.mkrecipe]
-conda-channels = [ "domdfcoding",]
-extras = "all"
-license-key = "Apache2.0"
-package = "ytools"
-
 [tool.sphinx-pyproject]
 github_username = "domdfcoding"
 github_repository = "ytools3"
@@ -60,10 +54,10 @@ extensions = [
     "sphinx_toolbox.more_autosummary",
     "sphinx_toolbox.documentation_summary",
     "sphinx_toolbox.tweaks.param_dash",
+    "sphinx_toolbox.tweaks.latex_layout",
     "sphinx_toolbox.tweaks.latex_toc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
-    "sphinxcontrib.httpdomain",
     "sphinxcontrib.extras_require",
     "sphinx.ext.todo",
     "sphinxemoji.sphinxemoji",
@@ -94,7 +88,6 @@ toctree_plus_types = [
     "exception",
     "flag",
     "function",
-    "method",
     "namedtuple",
     "protocol",
     "role",
@@ -122,3 +115,18 @@ autodoc_exclude_members = [
     "__abstractmethods__",
     "__hash__",
 ]
+
+[tool.whey]
+base-classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+    "Typing :: Typed",
+]
+python-versions = [ "3.6", "3.7", "3.8", "3.9",]
+python-implementations = [ "CPython",]
+platforms = [ "Windows", "macOS", "Linux",]
+license-key = "Apache2.0"
+package = "ytools"

setup.py

@@ -22,8 +22,8 @@
 		"Library for validating yaml files against schema and selectively dumping nodes from yaml (or json) documents in yaml or json format.",
 		extras_require=extras_require,
 		install_requires=install_requires,
+		name="ytools3",
 		py_modules=[],
-		version=__version__,
 		)
 
 shutil.rmtree("ytools3.egg-info", ignore_errors=True)

tox.ini

@@ -80,6 +80,7 @@ deps =
     git+https://github.com/domdfcoding/flake8-rst-docstrings.git
     pydocstyle>=6.0.0
     pygments>=2.7.1
+    importlib_metadata<4.5.0; python_version<'3.8'
 commands = python3 -m flake8_rst_docstrings_sphinx ytools tests --allow-toolbox {posargs}
 
 [testenv:mypy]