:py:mod:`myst_parser.inventory`
===============================

.. py:module:: myst_parser.inventory

.. autodoc2-docstring:: myst_parser.inventory
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`InventoryItemType <myst_parser.inventory.InventoryItemType>`
     - .. autodoc2-docstring:: myst_parser.inventory.InventoryItemType
          :summary:
   * - :py:obj:`InventoryType <myst_parser.inventory.InventoryType>`
     - .. autodoc2-docstring:: myst_parser.inventory.InventoryType
          :summary:
   * - :py:obj:`InventoryFileReader <myst_parser.inventory.InventoryFileReader>`
     - .. autodoc2-docstring:: myst_parser.inventory.InventoryFileReader
          :summary:
   * - :py:obj:`InvMatch <myst_parser.inventory.InvMatch>`
     - .. autodoc2-docstring:: myst_parser.inventory.InvMatch
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`from_sphinx <myst_parser.inventory.from_sphinx>`
     - .. autodoc2-docstring:: myst_parser.inventory.from_sphinx
          :summary:
   * - :py:obj:`to_sphinx <myst_parser.inventory.to_sphinx>`
     - .. autodoc2-docstring:: myst_parser.inventory.to_sphinx
          :summary:
   * - :py:obj:`load <myst_parser.inventory.load>`
     - .. autodoc2-docstring:: myst_parser.inventory.load
          :summary:
   * - :py:obj:`match_with_wildcard <myst_parser.inventory.match_with_wildcard>`
     - .. autodoc2-docstring:: myst_parser.inventory.match_with_wildcard
          :summary:
   * - :py:obj:`filter_inventories <myst_parser.inventory.filter_inventories>`
     - .. autodoc2-docstring:: myst_parser.inventory.filter_inventories
          :summary:
   * - :py:obj:`filter_sphinx_inventories <myst_parser.inventory.filter_sphinx_inventories>`
     - .. autodoc2-docstring:: myst_parser.inventory.filter_sphinx_inventories
          :summary:
   * - :py:obj:`filter_string <myst_parser.inventory.filter_string>`
     - .. autodoc2-docstring:: myst_parser.inventory.filter_string
          :summary:
   * - :py:obj:`fetch_inventory <myst_parser.inventory.fetch_inventory>`
     - .. autodoc2-docstring:: myst_parser.inventory.fetch_inventory
          :summary:
   * - :py:obj:`inventory_cli <myst_parser.inventory.inventory_cli>`
     - .. autodoc2-docstring:: myst_parser.inventory.inventory_cli
          :summary:

API
~~~

.. py:class:: InventoryItemType()
   :canonical: myst_parser.inventory.InventoryItemType

   Bases: :py:obj:`typing.TypedDict`

   .. autodoc2-docstring:: myst_parser.inventory.InventoryItemType

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.inventory.InventoryItemType.__init__

   .. py:attribute:: loc
      :canonical: myst_parser.inventory.InventoryItemType.loc
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InventoryItemType.loc

   .. py:attribute:: text
      :canonical: myst_parser.inventory.InventoryItemType.text
      :type: str | None
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InventoryItemType.text

.. py:class:: InventoryType()
   :canonical: myst_parser.inventory.InventoryType

   Bases: :py:obj:`typing.TypedDict`

   .. autodoc2-docstring:: myst_parser.inventory.InventoryType

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.inventory.InventoryType.__init__

   .. py:attribute:: name
      :canonical: myst_parser.inventory.InventoryType.name
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InventoryType.name

   .. py:attribute:: version
      :canonical: myst_parser.inventory.InventoryType.version
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InventoryType.version

   .. py:attribute:: base_url
      :canonical: myst_parser.inventory.InventoryType.base_url
      :type: str | None
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InventoryType.base_url

   .. py:attribute:: objects
      :canonical: myst_parser.inventory.InventoryType.objects
      :type: dict[str, dict[str, dict[str, myst_parser.inventory.InventoryItemType]]]
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InventoryType.objects

.. py:function:: from_sphinx(inv: sphinx.util.typing.Inventory) -> myst_parser.inventory.InventoryType
   :canonical: myst_parser.inventory.from_sphinx

   .. autodoc2-docstring:: myst_parser.inventory.from_sphinx

.. py:function:: to_sphinx(inv: myst_parser.inventory.InventoryType) -> sphinx.util.typing.Inventory
   :canonical: myst_parser.inventory.to_sphinx

   .. autodoc2-docstring:: myst_parser.inventory.to_sphinx

.. py:function:: load(stream: typing.IO, base_url: str | None = None) -> myst_parser.inventory.InventoryType
   :canonical: myst_parser.inventory.load

   .. autodoc2-docstring:: myst_parser.inventory.load

.. py:class:: InventoryFileReader(stream: typing.IO)
   :canonical: myst_parser.inventory.InventoryFileReader

   .. autodoc2-docstring:: myst_parser.inventory.InventoryFileReader

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.inventory.InventoryFileReader.__init__

   .. py:method:: read_buffer() -> None
      :canonical: myst_parser.inventory.InventoryFileReader.read_buffer

      .. autodoc2-docstring:: myst_parser.inventory.InventoryFileReader.read_buffer

   .. py:method:: readline() -> str
      :canonical: myst_parser.inventory.InventoryFileReader.readline

      .. autodoc2-docstring:: myst_parser.inventory.InventoryFileReader.readline

   .. py:method:: readlines() -> collections.abc.Iterator[str]
      :canonical: myst_parser.inventory.InventoryFileReader.readlines

      .. autodoc2-docstring:: myst_parser.inventory.InventoryFileReader.readlines

   .. py:method:: read_compressed_chunks() -> collections.abc.Iterator[bytes]
      :canonical: myst_parser.inventory.InventoryFileReader.read_compressed_chunks

      .. autodoc2-docstring:: myst_parser.inventory.InventoryFileReader.read_compressed_chunks

   .. py:method:: read_compressed_lines() -> collections.abc.Iterator[str]
      :canonical: myst_parser.inventory.InventoryFileReader.read_compressed_lines

      .. autodoc2-docstring:: myst_parser.inventory.InventoryFileReader.read_compressed_lines

.. py:function:: match_with_wildcard(name: str, pattern: str | None) -> bool
   :canonical: myst_parser.inventory.match_with_wildcard

   .. autodoc2-docstring:: myst_parser.inventory.match_with_wildcard

.. py:class:: InvMatch
   :canonical: myst_parser.inventory.InvMatch

   .. autodoc2-docstring:: myst_parser.inventory.InvMatch

   .. py:attribute:: inv
      :canonical: myst_parser.inventory.InvMatch.inv
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.inv

   .. py:attribute:: domain
      :canonical: myst_parser.inventory.InvMatch.domain
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.domain

   .. py:attribute:: otype
      :canonical: myst_parser.inventory.InvMatch.otype
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.otype

   .. py:attribute:: name
      :canonical: myst_parser.inventory.InvMatch.name
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.name

   .. py:attribute:: project
      :canonical: myst_parser.inventory.InvMatch.project
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.project

   .. py:attribute:: version
      :canonical: myst_parser.inventory.InvMatch.version
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.version

   .. py:attribute:: base_url
      :canonical: myst_parser.inventory.InvMatch.base_url
      :type: str | None
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.base_url

   .. py:attribute:: loc
      :canonical: myst_parser.inventory.InvMatch.loc
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.loc

   .. py:attribute:: text
      :canonical: myst_parser.inventory.InvMatch.text
      :type: str | None
      :value: None

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.text

   .. py:method:: asdict() -> dict[str, str]
      :canonical: myst_parser.inventory.InvMatch.asdict

      .. autodoc2-docstring:: myst_parser.inventory.InvMatch.asdict

.. py:function:: filter_inventories(inventories: dict[str, myst_parser.inventory.InventoryType], *, invs: str | None = None, domains: str | None = None, otypes: str | None = None, targets: str | None = None) -> collections.abc.Iterator[myst_parser.inventory.InvMatch]
   :canonical: myst_parser.inventory.filter_inventories

   .. autodoc2-docstring:: myst_parser.inventory.filter_inventories

.. py:function:: filter_sphinx_inventories(inventories: dict[str, sphinx.util.typing.Inventory], *, invs: str | None = None, domains: str | None = None, otypes: str | None = None, targets: str | None = None) -> collections.abc.Iterator[myst_parser.inventory.InvMatch]
   :canonical: myst_parser.inventory.filter_sphinx_inventories

   .. autodoc2-docstring:: myst_parser.inventory.filter_sphinx_inventories

.. py:function:: filter_string(invs: str | None, domains: str | None, otype: str | None, target: str | None, *, delimiter: str = ':') -> str
   :canonical: myst_parser.inventory.filter_string

   .. autodoc2-docstring:: myst_parser.inventory.filter_string

.. py:function:: fetch_inventory(uri: str, *, timeout: None | float = None, base_url: None | str = None) -> myst_parser.inventory.InventoryType
   :canonical: myst_parser.inventory.fetch_inventory

   .. autodoc2-docstring:: myst_parser.inventory.fetch_inventory

.. py:function:: inventory_cli(inputs: None | list[str] = None)
   :canonical: myst_parser.inventory.inventory_cli

   .. autodoc2-docstring:: myst_parser.inventory.inventory_cli