Metadata-Version: 2.4
Name: sphinxcontrib-nixdomain
Version: 0.1.5
Summary: Nix domain and autodoc for Sphinx
Project-URL: Documentation, https://sphinxcontrib-nixdomain.readthedocs.io/en/stable/index.html
Project-URL: Changelog, https://sphinxcontrib-nixdomain.readthedocs.io/en/stable/reference/changelog.html
Project-URL: Issues, https://github.com/minijackson/sphinxcontrib-nixdomain/issues
Project-URL: Source, https://github.com/minijackson/sphinxcontrib-nixdomain
Author-email: Minijackson <minijackson@riseup.net>
Maintainer-email: Minijackson <minijackson@riseup.net>
License-Expression: EUPL-1.2
License-File: LICENSE.txt
Keywords: nix,sphinx
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Domain
Classifier: Framework :: Sphinx :: Extension
Classifier: License :: OSI Approved
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation :: Sphinx
Requires-Python: >=3.10
Requires-Dist: pydantic>=2.0.0
Requires-Dist: sphinx>=7.4.0
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: sphinx-design; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest; extra == 'tests'
Description-Content-Type: text/markdown

# sphinxcontrib-nixdomain

[![PyPI - Version](https://img.shields.io/pypi/v/sphinxcontrib-nixdomain.svg)](https://pypi.org/project/sphinxcontrib-nixdomain)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinxcontrib-nixdomain.svg)](https://pypi.org/project/sphinxcontrib-nixdomain)

-----

`sphinxcontrib-nixdomain` is a [Sphinx] extension
providing a [Sphinx domain] for [Nix].

The goal of this project is to be able to document
NixOS module options,
Nix packages,
Nix libraries,
using the Sphinx documentation ecosystem.

  [Sphinx]: https://www.sphinx-doc.org/
  [Sphinx domain]: https://www.sphinx-doc.org/en/master/usage/domains/index.html
  [Nix]: https://nixos.org/

## Documentation

See the [`sphinxcontrib-nixdomain` documentation] for installation and usage.

  [`sphinxcontrib-nixdomain` documentation]: https://sphinxcontrib-nixdomain.readthedocs.io/en/stable/index.html

## License

Licensed under the EUPL
