httk.core.docs.release
======================

.. py:module:: httk.core.docs.release

.. autoapi-nested-parse::

   Release-tag checks, lock validation, and deterministic documentation URLs.

   When ``docs/versioning.toml`` is present, release checks assume each internal
   repository's Sphinx project name equals its configured documentation slug and
   validate the corresponding committed ``docs/_inventories/<slug>.inv`` header.



Exceptions
----------

.. autoapisummary::

   httk.core.docs.release.ReleaseError


Classes
-------

.. autoapisummary::

   httk.core.docs.release.ReleaseCheck


Functions
---------

.. autoapisummary::

   httk.core.docs.release.check_release
   httk.core.docs.release.dependency_doc_targets


Module Contents
---------------

.. py:exception:: ReleaseError

   Bases: :py:obj:`RuntimeError`


   Raised when a release tag, project version, or documentation lock is invalid.


.. py:class:: ReleaseCheck

   Summary of a successful release preflight.


   .. py:attribute:: tag
      :type:  str


   .. py:attribute:: version
      :type:  httk.core.docs.semver.Version


   .. py:attribute:: lock_path
      :type:  pathlib.Path


.. py:function:: check_release(project_dir: str | pathlib.Path, tag: str) -> ReleaseCheck

   Validate a release tag against ``pyproject.toml`` and its docs lock.


.. py:function:: dependency_doc_targets(config: httk.core.docs.config.VersioningConfig, pins: collections.abc.Mapping[str, str], base_url: str, channel: str) -> dict[str, str]

   Derive exact release or ``dev/main`` inventory URLs for internal dependencies.