build: copier-auto-update

Author: KyleKing

.copier-answers.yml

@@ -2,7 +2,7 @@
 # Answer file maintained by Copier for: https://github.com/KyleKing/calcipy_template
 # DO NOT MODIFY THIS FILE. Edit by re-running copier and changing responses to the questions
 # Check into version control.
-_commit: 1.10.7
+_commit: 2.0.3
 _src_path: gh:KyleKing/calcipy_template
 author_email: [email protected]
 author_name: Kyle King

.github/workflows/ci_pipeline.yml

@@ -12,10 +12,6 @@ name: CI Pipeline
       - poetry.lock
       - pyproject.toml
 
-env:
-  COLUMNS: 120
-  PYTEST_ADDOPTS: "--snapshot-warn-unused"
-
 jobs:
   lint:
     runs-on: ${{ matrix.os }}

.github/workflows/update_docs.yml

@@ -29,8 +29,6 @@ jobs:
         with:
           os: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
-      - name: Setup Graphviz
-        uses: ts-graphviz/setup-graphviz@v2
 
         # https://github.com/mkdocs/mkdocs/discussions/2369#discussioncomment-625475
       - name: Configure git user

.pre-commit-config.yaml

@@ -50,7 +50,7 @@ repos:
     hooks:
       - id: mdformat
         additional_dependencies:
-          - "mdformat-mkdocs[recommended]>=2.1.0"
+          - "mdformat-mkdocs[recommended]>=3.0.0"
           - "mdformat-gfm-alerts>=1.0.1"
         args: [--wrap=no]
         exclude: _.+\.md|CHANGELOG\.md|CODE_TAG_SUMMARY\.md
@@ -72,18 +72,11 @@ repos:
         exclude: \.copier-answers\.yml|tests/.*/cassettes/.*\.yaml|__snapshots__/.*\.json
         types_or: [html, javascript, json, shell, yaml]
         stages: ["pre-commit"]
-  - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.35.1
-    hooks:
-      - id: yamllint
-        exclude: tests/.*/cassettes/.*\.yaml
-        stages: ["pre-commit"]
   - repo: https://github.com/pappasam/toml-sort
     rev: v0.23.1
     hooks:
       - id: toml-sort-fix
-        # Don't remove comments and sort order from test files
-        exclude: poetry\.lock|config_default.toml|demo_config.toml
+        exclude: poetry\.lock
         stages: ["pre-commit"]
   - repo: https://github.com/KyleKing/calcipy
     rev: 4.0.0

.tool-versions

@@ -1 +1 @@
-python 3.12.0 3.9.13
+python 3.12.5 3.9.13

.yamllint.yaml

@@ -1,39 +1,56 @@
-"""Generate the code reference pages and navigation.
+"""Generate the code reference pages.
 
-Copied from:
-https://github.com/pawamoy/copier-pdm/blob/79135565c4c7f756204a5f460e87129649f8b704/project/docs/gen_ref_nav.py
+Adapted without navigation from:
+https://github.com/pawamoy/copier-pdm/blob/adff9b64887d0b4c9ec0b42de1698b34858a511e/project/scripts/gen_ref_nav.py
 
 """
 
 from pathlib import Path
 
 import mkdocs_gen_files
+from corallium.tomllib import tomllib
 
-nav = mkdocs_gen_files.Nav()
 
-for path in sorted(Path('tail_jsonl').rglob('*.py')):
+def has_public_code(line: str) -> bool:
+    """Determine if a given line contains code that will be documented.
+
+    Returns:
+        bool: True if line appears to be a public function, class, or method
+
+    """
+    for key in ('def', 'async def', 'class'):
+        starts = line.startswith(f'{key} ')
+        if starts and not line.startswith(f'{key} _'):
+            return True
+        if starts:
+            break
+    return False
+
+
+_config = tomllib.loads(Path('pyproject.toml').read_text(encoding='utf-8'))
+_pkg_name = _config['tool']['poetry']['name']
+src = Path(_pkg_name)
+for path in sorted(src.rglob('*.py')):
+    for line in path.read_text().split('\n'):
+        if has_public_code(line):
+            break
+    else:
+        continue  # Do not include the file in generated documentation
+
     module_path = path.with_suffix('')
     doc_path = path.with_suffix('.md')
     full_doc_path = Path('reference', doc_path)
 
     parts = tuple(module_path.parts)
-
     if parts[-1] == '__init__':
         parts = parts[:-1]
         doc_path = doc_path.with_name('index.md')
         full_doc_path = full_doc_path.with_name('index.md')
-    elif parts[-1] == '__main__':
+    elif parts[-1].startswith('_'):
         continue
 
-    nav[parts] = doc_path.as_posix()
-
     with mkdocs_gen_files.open(full_doc_path, 'w') as fd:
         ident = '.'.join(parts)
         fd.write(f'::: {ident}')
 
     mkdocs_gen_files.set_edit_path(full_doc_path, path)
-
-# FYI, to add pages manually, use: `nav["package", "module"] = "path/to/file.md"`
-
-with mkdocs_gen_files.open('reference/SUMMARY.md', 'w') as nav_file:
-    nav_file.writelines(nav.build_literate_nav())

docs/docs/Advanced_Documentation.md

@@ -23,25 +23,9 @@ watch:
   - tail_jsonl
 
 plugins:
-  - build_plantuml:
-      render: server # or "local"
-      bin_path: /usr/local/bin/plantuml # ignored when render: server
-      server: http://www.plantuml.com/plantuml # official plantuml server
-      output_format: svg
-      diagram_root: docs/diagrams
-      output_folder: out
-      input_folder: src
-      input_extensions: puml
   - gen-files:
       scripts:
         - docs/gen_ref_nav.py
-  - git-revision-date-localized:
-      enable_creation_date: true
-      fallback_to_build_date: true
-      strict: false
-      type: date
-  - literate-nav:
-      nav_file: SUMMARY.md
   - mkdocstrings:
       handlers:
         python:
@@ -51,7 +35,6 @@ plugins:
             separate_signature: true
             show_category_heading: true
   - search
-  - section-index
 
 markdown_extensions:
   - abbr

docs/gen_ref_nav.py

@@ -39,7 +39,6 @@ classifiers = [
 ] # https://pypi.org/classifiers/
 description = "Pretty Print Tailed JSONL Logs"
 documentation = "https://tail-jsonl.kyleking.me"
-include = ["LICENSE"]
 keywords = ["calcipy_template"]
 license = "MIT"
 maintainers = []
@@ -140,13 +139,17 @@ known-first-party = ['tail_jsonl']
   'ANN001', # Missing type annotation for function argument
   'ANN201', # Missing return type annotation for public function
   'ANN202', # Missing return type annotation for private function `test_make_diffable`
+  'ARG001', # Unused function argument: `line`
   'D100', # Missing docstring in public module
   'D103', # Missing docstring in public function
   'PLC2701', # Private name import `_<>` from external module
   'PT004', # flake8-pytest-style: fixture does not return
   'S101', # Use of `assert` detected
 ]
 
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
 [tool.tomlsort]
 all = true
 in_place = true