documenteer 1.4.2__tar.gz → 2.0.0a2__tar.gz

{documenteer-1.4.2 → documenteer-2.0.0a2}/.github/workflows/ci-cron.yaml

@@ -4,6 +4,9 @@
 
 name: Periodic CI
 
+env:
+  PYTHON_VERSION: "3.12"
+
 "on":
   schedule:
     - cron: "0 12 * * 1"
@@ -19,6 +22,7 @@ jobs:
           - "3.12"
         sphinx-version:
           - "7"
+          - "8"
           - "dev"
 
     steps:
@@ -64,7 +68,7 @@ jobs:
       - name: Build docs in tox
         uses: lsst-sqre/run-tox@v1
         with:
-          python-version: "3.12"
+          python-version: ${{ env.PYTHON_VERSION }}
           tox-envs: "docs,docs-lint"
           use-cache: false
 
@@ -94,5 +98,5 @@ jobs:
       - name: Build and publish
         uses: lsst-sqre/build-and-publish-to-pypi@v2
         with:
-          python-version: "3.12"
+          python-version: ${{ env.PYTHON_VERSION }}
           upload: false

{documenteer-1.4.2 → documenteer-2.0.0a2}/.github/workflows/ci.yaml

@@ -1,5 +1,8 @@
 name: CI
 
+env:
+  PYTHON_VERSION: '3.12' # Default Python version
+
 'on':
   push:
     branches-ignore:
@@ -39,6 +42,7 @@ jobs:
           - '3.12'
         sphinx-version:
           - '7'
+          - '8'
 
     steps:
       - uses: actions/checkout@v4
@@ -76,7 +80,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # full history for setuptools_scm
 
@@ -86,7 +90,7 @@ jobs:
       - name: Run tox
         uses: lsst-sqre/run-tox@v1
         with:
-          python-version: '3.12'
+          python-version: ${{ env.PYTHON_VERSION }}
           tox-envs: 'docs,docs-lint'
 
       # Only attempt documentation uploads for tagged releases and pull
@@ -115,7 +119,7 @@ jobs:
       - name: Build and publish
         uses: lsst-sqre/build-and-publish-to-pypi@v2
         with:
-          python-version: "3.12"
+          python-version: ${{ env.PYTHON_VERSION }}
           upload: "false"
 
   pypi-publish:
@@ -147,4 +151,4 @@ jobs:
       - name: Build and publish
         uses: lsst-sqre/build-and-publish-to-pypi@v2
         with:
-          python-version: '3.12'
+          python-version: ${{ env.PYTHON_VERSION }}

{documenteer-1.4.2 → documenteer-2.0.0a2}/.pre-commit-config.yaml

@@ -14,29 +14,19 @@ repos:
       - id: rst-linter
         files: (README\.rst)|(CHANGELOG\.rst)
 
-  - repo: https://github.com/PyCQA/isort/
-    rev: 5.13.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.1
     hooks:
-      - id: isort
-        additional_dependencies:
-          - toml
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
 
-  - repo: https://github.com/psf/black
-    rev: 24.4.2
-    hooks:
-      - id: black
-
-  - repo: https://github.com/asottile/blacken-docs
-    rev: 1.16.0
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.18.0
     hooks:
       - id: blacken-docs
-        additional_dependencies: [black==22.12.0]
-        args: [-l, '79', -t, py38]
-
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.0.0
-    hooks:
-      - id: flake8
+        additional_dependencies: [black==24.4.2]
+        args: [-l, '79', -t, py312]
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8

documenteer-2.0.0a2/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "[python]": {
+  }
+}

{documenteer-1.4.2 → documenteer-2.0.0a2}/CHANGELOG.md

@@ -2,20 +2,6 @@
 
 <!-- scriv-insert-here -->
 
-<a id='changelog-1.4.2'></a>
-## 1.4.2 (2024-10-15)
-
-### Bug fixes
-
-- Bump `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with sphinx==1.8.1, and allows us to unpin the version of mermaid JS.
-
-<a id='changelog-1.4.1'></a>
-## 1.4.1 (2024-10-10)
-
-### Bug fixes
-
-- Pin `sphinx` to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
-
 <a id='changelog-1.4.0'></a>
 ## 1.4.0 (2024-07-11)
 

{documenteer-1.4.2/src/documenteer.egg-info → documenteer-2.0.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: documenteer
-Version: 1.4.2
+Version: 2.0.0a2
 Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
 License: The MIT License (MIT)
         
@@ -27,18 +27,20 @@ License: The MIT License (MIT)
 Project-URL: Homepage, https://documenteer.lsst.io
 Project-URL: Source, https://github.com/lsst-sqre/documenteer
 Keywords: rubin,lsst
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Documentation
 Classifier: Topic :: Documentation :: Sphinx
-Classifier: Framework :: Sphinx :: Extension
-Classifier: Environment :: Console
-Classifier: Natural Language :: English
-Classifier: Operating System :: POSIX
+Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -70,6 +72,7 @@ Requires-Dist: types-PyYAML; extra == "dev"
 Requires-Dist: types-docutils; extra == "dev"
 Requires-Dist: types-mock; extra == "dev"
 Provides-Extra: guide
+Requires-Dist: autodoc_pydantic; extra == "guide"
 Requires-Dist: sphinx_design; extra == "guide"
 Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "guide"
 Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
@@ -80,29 +83,12 @@ Requires-Dist: sphinx-jinja>=2; extra == "guide"
 Requires-Dist: myst-parser; extra == "guide"
 Requires-Dist: myst-nb; extra == "guide"
 Requires-Dist: markdown-it-py[linkify]; extra == "guide"
-Requires-Dist: sphinxcontrib-mermaid>=1; extra == "guide"
+Requires-Dist: sphinxcontrib-mermaid; extra == "guide"
 Requires-Dist: sphinxext-opengraph; extra == "guide"
 Requires-Dist: sphinxcontrib-redoc; extra == "guide"
 Requires-Dist: sphinxcontrib-jquery; extra == "guide"
 Requires-Dist: sphinxext-rediraffe; extra == "guide"
 Requires-Dist: sphinxcontrib-youtube; extra == "guide"
-Provides-Extra: pipelines
-Requires-Dist: sphinx_design; extra == "pipelines"
-Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "pipelines"
-Requires-Dist: sphinx-autodoc-typehints; extra == "pipelines"
-Requires-Dist: sphinx-automodapi; extra == "pipelines"
-Requires-Dist: sphinx-copybutton; extra == "pipelines"
-Requires-Dist: sphinx-prompt; extra == "pipelines"
-Requires-Dist: sphinx-jinja>=2; extra == "pipelines"
-Requires-Dist: myst-parser; extra == "pipelines"
-Requires-Dist: markdown-it-py[linkify]; extra == "pipelines"
-Requires-Dist: sphinxcontrib-mermaid; extra == "pipelines"
-Requires-Dist: sphinxext-opengraph; extra == "pipelines"
-Requires-Dist: sphinxcontrib-redoc; extra == "pipelines"
-Requires-Dist: sphinxcontrib-jquery; extra == "pipelines"
-Requires-Dist: sphinxcontrib-autoprogram; extra == "pipelines"
-Requires-Dist: sphinxcontrib-doxylink; extra == "pipelines"
-Requires-Dist: sphinx-click; extra == "pipelines"
 Provides-Extra: technote
 Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
 Requires-Dist: sphinx-prompt; extra == "technote"

documenteer-2.0.0a2/changelog.d/20240819_152413_jsick_DM_45803.md

@@ -0,0 +1,33 @@
+### Backwards-incompatible changes
+
+- All Science Pipelines-related tooling and Sphinx extensions have been removed from Documenteer, and can now be found in a new Science Pipelines package called `sphinxutils` (https://github.com/lsst-dm/sphinxutils). Specific removals include:
+
+  - `documenteer.stackdocs`
+  - Configurations `documenteer.conf.pipelines` and `documenteer.conf.pipelinespkg`
+  - CLI commands `stack-docs` and `package-docs`
+  - Sphinx extensions:
+    - `documenteer.ext.lssttasks`
+    - `documenteer.ext.packagetoctree`
+    - `documenteer.ext.autocppapi`
+    - `documenteer.ext.autodocreset`
+
+### New features
+
+- User guide configuration improvements:
+
+  - New custom automodapi templates for Pydantic BaseModels and exceptions. The exception template ensures that inherited members of exceptions are documented. The Pydantic BaseModel template ensures that inherited members from the `BaseModel` class itself are _not_ documented. These templates were originally developed as part of [Gafaelfawr](https://github.com/lsst-sqre/gafaelfawr). Now users of the user guide configuration benefit from these templates without any additional configuration.
+
+  - The `[guide]` installation extra and `documenteer.conf.guide` configuration now include `autodoc_pydantic` for improved documentation of Pydantic models in Python API references.
+
+  - The `documenteer.conf.guide` configuration now ignores common Sphinx warnings that are common when including references to projects that don't use Sphinx/Intersphinx for this documentation, including Pydantic and FastAPI.
+
+- The entire `documenteer` code base is now type annotated.
+
+### Bug fixes
+
+-
+
+### Other changes
+
+- The code base is now linted and formatted with ruff.
+- Start testing against Sphinx 8.

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/Makefile

@@ -1,8 +1,7 @@
 # Makefile for Sphinx documentation
 
 # You can set these variables from the command line.
-# SPHINXOPTS    = -n -W
-SPHINXOPTS    = -n
+SPHINXOPTS    = -n -W
 SPHINXBUILD   = sphinx-build
 BUILDDIR      = _build
 

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/_rst_epilog.rst

@@ -27,7 +27,6 @@
 .. _TOML: https://toml.io/en/
 .. _`SQR-006`: https://sqr-006.lsst.io
 .. _`lsstDoxygen`: https://github.com/lsst/lsstDoxygen
-.. _`package-docs`: https://documenteer.lsst.io/pipelines/package-docs-cli.html
 .. _`pex_config`: https://github.com/lsst/pex_config
 .. _`pipe_base`: https://github.com/lsst/pipe_base
 .. _`pipe_supertask`: https://github.com/lsst/pipe_supertask
@@ -70,10 +69,6 @@
 
 .. |documenteer.toml| replace:: :doc:`documenteer.toml </guides/toml-reference>`
 .. |documenteer.conf.guide| replace:: :doc:`documenteer.conf.guide </guides/configuration-preset>`
-.. |package-docs| replace:: :doc:`package-docs </guides/pipelines/package-docs-cli>`
-.. |stack-docs| replace:: :doc:`stack-docs </guides/pipelines/stack-docs-cli>`
-.. |stack-docs-build| replace:: :doc:`stack-docs build </guides/pipelines/stack-docs-cli>`
-.. |stack-docs-clean| replace:: :doc:`stack-docs clean </guides/pipelines/stack-docs-cli>`
 
 .. links to sphinx directives
 

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/changelog.md

@@ -2,20 +2,6 @@
 
 <!-- scriv-insert-here -->
 
-<a id='changelog-1.4.2'></a>
-## 1.4.2 (2024-10-15)
-
-### Bug fixes
-
-- Bump `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with sphinx==1.8.1, and allows us to unpin the version of mermaid JS.
-
-<a id='changelog-1.4.1'></a>
-## 1.4.1 (2024-10-10)
-
-### Bug fixes
-
-- Pin `sphinx` to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
-
 <a id='changelog-1.4.0'></a>
 ## 1.4.0 (2024-07-11)
 

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/dev/api/documenteer.ext.rst

@@ -2,10 +2,6 @@
 documenteer.ext
 ###############
 
-.. automodapi:: documenteer.ext.autocppapi
-
-.. automodapi:: documenteer.ext.autodocreset
-
 .. automodapi:: documenteer.ext.openapi
 
 .. automodapi:: documenteer.ext.bibtex
@@ -20,6 +16,3 @@ documenteer.ext
 
 .. automodapi:: documenteer.ext.mockcoderefs
    :no-inheritance-diagram:
-
-.. automodapi:: documenteer.ext.packagetoctree
-   :no-inheritance-diagram:

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/dev/api/index.rst

@@ -8,5 +8,3 @@ Python API
    documenteer.conf
    documenteer.ext
    documenteer.requestsutils
-   documenteer.sphinxrunner
-   documenteer.stackdocs

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/documenteer.toml

@@ -11,6 +11,7 @@ package = "documenteer"
 extensions = [
   "sphinx_click.ext",
   "sphinxcontrib.autoprogram",
+  "sphinxcontrib.autodoc_pydantic"
 ]
 disable_primary_sidebars = ["index", "changelog"]
 rst_epilog_file = "_rst_epilog.rst"
@@ -25,7 +26,8 @@ nitpick_ignore_regex = [
 ]
 python_api_dir = "dev/api/contents"
 exclude = [
-  "technotes/_templates/*"
+  "technotes/_templates/*",
+  "_templates/**"
 ]
 
 [sphinx.theme]
@@ -46,10 +48,10 @@ ignore = [
 ]
 
 [sphinx.redirects]
-"pipelines/build-overview.rst" = "guides/pipelines/build-overview.rst"
-"pipelines/configuration.rst" = "guides/pipelines/configuration.rst"
-"pipelines/cpp-api-linking.rst" = "guides/pipelines/cpp-api-linking.rst"
-"pipelines/index.rst" = "guides/pipelines/index.rst"
-"pipelines/install.rst" = "guides/pipelines/install.rst"
-"pipelines/package-docs-cli.rst" = "guides/pipelines/package-docs-cli.rst"
-"pipelines/stack-docs-cli.rst" = "guides/pipelines/stack-docs-cli.rst"
+"pipelines/build-overview.rst" = "guides/index.rst"
+"pipelines/configuration.rst" = "guides/index.rst"
+"pipelines/cpp-api-linking.rst" = "guides/index.rst"
+"pipelines/index.rst" = "guides/index.rst"
+"pipelines/install.rst" = "guides/index.rst"
+"pipelines/package-docs-cli.rst" = "guides/index.rst"
+"pipelines/stack-docs-cli.rst" = "guides/index.rst"

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/guides/index.rst

@@ -47,14 +47,6 @@ Documenteer provides a configuration profile for creating branded user guides wi
    markdown-primer
    including-notebooks
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Science Pipelines
-   :name: toc-guides-pipelines
-   :titlesonly:
-
-   pipelines/index
-
 .. toctree::
    :maxdepth: 2
    :caption: Reference

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/guides/page-redirects.rst

@@ -23,7 +23,7 @@ These paths are relative to the documentation project's root directory (where :f
 The table accepts an arbitrary number of redirects:
 
 .. code-block:: toml
-   :captin: documenteer.toml
+   :caption: documenteer.toml
 
    [sphinx.redirects]
    "old-page.rst" = "some-dir/new-page.rst"

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/index.rst

@@ -42,14 +42,6 @@ Installation
 
          pip install "documenteer[technote]"
 
-      For :doc:`LSST Science Pipelines projects and other EUPS stacks </guides/pipelines/index>`:
-
-      .. code-block:: sh
-
-         pip install "documenteer[pipelines]"
-
-      See :doc:`/guides/pipelines/install` for more information.
-
    .. tab-item:: conda
 
       Documenteer is available from `conda-forge`_ for Conda_ users.
@@ -74,17 +66,11 @@ Installation
 
          conda-install lsst-documenteer-technote
 
-      To install Documenteer for LSST Stack projects (such as https://pipelines.lsst.io and EUPS packages):
-
-      .. code-block:: sh
-
-         conda-install lsst-documenteer-pipelines
-
 Project guides
 ==============
 
 Documenteer provides centralized Sphinx configuration and support for Rubin Observatory documentation projects.
-This section describes how to use Documenteer for specific types of projects, from single-page technical notes to user guides, to LSST Science Pipelines package documentation.
+This section describes how to use Documenteer for specific types of projects, from single-page technical notes to user guides.
 
 .. toctree::
    :maxdepth: 2

{documenteer-1.4.2 → documenteer-2.0.0a2}/docs/sphinx-extensions/index.rst

@@ -19,13 +19,3 @@ Sphinx extensions
 
    remote-code-block
    openapi
-   autodocreset
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-   :caption: Science Pipelines
-
-   lssttasks
-   autocppapi
-   package-toctree

{documenteer-1.4.2 → documenteer-2.0.0a2}/pyproject.toml

@@ -7,18 +7,20 @@ readme = "README.md"
 keywords = ["rubin", "lsst"]
 # https://pypi.org/classifiers/
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Framework :: Sphinx :: Extension",
+    "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: POSIX",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.11",
-    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Documentation",
     "Topic :: Documentation :: Sphinx",
-    "Framework :: Sphinx :: Extension",
-    "Environment :: Console",
-    "Natural Language :: English",
-    "Operating System :: POSIX",
+    "Typing :: Typed",
 ]
 requires-python = ">=3.11"
 dynamic = ["version"]
@@ -61,6 +63,7 @@ dev = [
 ]
 guide = [
     # Theme and extensions for Rubin user guide projects
+    "autodoc_pydantic",
     "sphinx_design",
     "pydata-sphinx-theme>=0.10.0,<0.13.0",
     "sphinx-autodoc-typehints",
@@ -71,36 +74,13 @@ guide = [
     "myst-parser",
     "myst-nb",
     "markdown-it-py[linkify]",
-    "sphinxcontrib-mermaid>=1",
+    "sphinxcontrib-mermaid",
     "sphinxext-opengraph",
     "sphinxcontrib-redoc",
     "sphinxcontrib-jquery",
     "sphinxext-rediraffe",
     "sphinxcontrib-youtube"
 ]
-pipelines = [
-    # Theme and extensions for pipelines.lsst.io
-    # Include all dependencies fof guide, and add additional dependencies
-    # specifically for pipelines.lsst.io
-    "sphinx_design",
-    "pydata-sphinx-theme>=0.10.0,<0.13.0",
-    "sphinx-autodoc-typehints",
-    "sphinx-automodapi",
-    "sphinx-copybutton",
-    "sphinx-prompt",
-    "sphinx-jinja>=2", # namespace changed in 2.0
-    "myst-parser",
-    "markdown-it-py[linkify]",
-    "sphinxcontrib-mermaid",
-    "sphinxext-opengraph",
-    "sphinxcontrib-redoc",
-    "sphinxcontrib-jquery",
-
-    # Additional extensions for Pipelines
-    "sphinxcontrib-autoprogram",
-    "sphinxcontrib-doxylink",
-    "sphinx-click",
-]
 technote = [
     # Theme and extensions for technotes
     "technote>=0.9.0,<0.10.0",
@@ -118,8 +98,6 @@ Source = "https://github.com/lsst-sqre/documenteer"
 
 [project.scripts]
 documenteer = "documenteer.cli:main"
-stack-docs = "documenteer.stackdocs.stackcli:main"
-package-docs = "documenteer.stackdocs.packagecli:main"
 
 [build-system]
 requires = ["setuptools>=61", "wheel", "setuptools_scm[toml]>=6.2"]
@@ -128,6 +106,7 @@ build-backend = 'setuptools.build_meta'
 [tool.setuptools_scm]
 
 [tool.black]
+# Black configuration is maintained for blacken-docs
 line-length = 79
 target-version = ['py311']
 exclude = '''
@@ -146,12 +125,6 @@ exclude = '''
 # Use single-quoted strings so TOML treats the string like a Python r-string
 # Multi-line strings are implicitly treated by black as regular expressions
 
-[tool.isort]
-profile = "black"
-line_length = 79
-known_first_party = "documenteer"
-skip = ["docs/conf.py"]
-
 [tool.coverage.run]
 parallel = true
 branch = true
@@ -181,10 +154,11 @@ norecursedirs = "node_modules"
 python_files = ["tests/*.py", "tests/*/*.py"]
 
 [tool.mypy]
-# provisional config; disallow_untyped_defs once fully typed
-disallow_untyped_defs = false
+disallow_untyped_defs = true
 disallow_incomplete_defs = true
 ignore_missing_imports = true
+local_partial_types = true
+no_implicit_reexport = true
 show_error_codes = true
 strict_equality = true
 warn_redundant_casts = true
@@ -192,6 +166,61 @@ warn_unreachable = true
 warn_unused_ignores = true
 plugins = ["pydantic.mypy"]
 
+[tool.ruff]
+extend = "ruff-shared.toml"
+
+[tool.ruff.lint]
+# Reference for settings: https://beta.ruff.rs/docs/settings/
+# Reference for rules: https://beta.ruff.rs/docs/rules/
+exclude = ["docs/**", "tests/roots/**", "demo/**"]
+extend-ignore = [
+   "FIX001", # allow FIXMEs
+   "TD001",  # relax formatting for TODOs
+   "TD002",  # don't require authors for TODOs
+   "TD004",  # don't require colons for TODOs
+]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"src/documenteer/services/technotemigration.py" = [
+    "T201",    # This script can use print
+]
+"tests/**" = [
+    "D103",    # tests don't need docstrings
+    "PLR0915", # tests are allowed to be long, sometimes that's convenient
+    "PT012",   # way too aggressive about limiting pytest.raises blocks
+    "S101",    # tests should use assert
+    "SLF001",  # tests are allowed to access private members
+    "T201",    # tests can print
+    # Temp rules for initial migration
+    "PGH003",  # relax having blanket type ignores in tests
+    "ANN001",
+    "ANN201",
+    "ANN202",
+    "PT006",
+    "PT021",
+]
+"tests/roots/**" = [
+    "INP001",  # These aren't importable packages
+]
+"src/documenteer/storage/localtemplates/**" = [
+    "S701",
+    "INP001",
+    "D100"
+]
+"src/documenteer/cli.py" = [
+    "T201",  # CLI scripts can print
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["documenteer", "tests"]
+split-on-trailing-comma = false
+
+[tool.ruff.lint.pep8-naming]
+classmethod-decorators = [
+    "pydantic.root_validator",  # for pydantic v1
+    "pydantic.validator",  # for pydantic v1
+]
+
 [tool.scriv]
 categories = [
     "Backwards-incompatible changes",