Metadata-Version: 2.4
Name: documenteer
Version: 2.1.1
Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
License-Expression: MIT
Project-URL: Homepage, https://documenteer.lsst.io
Project-URL: Source, https://github.com/lsst-sqre/documenteer
Keywords: rubin,lsst
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: licenses/README.md
License-File: licenses/astropy-helpers.txt
License-File: licenses/sphinx-issue.txt
License-File: licenses/sphinx.txt
License-File: licenses/sphinxcontrib-redoc.txt
Requires-Dist: docutils>=0.20
Requires-Dist: Sphinx<8.2,>=7
Requires-Dist: PyYAML
Requires-Dist: GitPython
Requires-Dist: requests
Requires-Dist: click
Requires-Dist: sphinxcontrib-bibtex>=2.6.5
Requires-Dist: pybtex>=0.25.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: urllib3
Requires-Dist: pylatexenc
Requires-Dist: tomlkit
Provides-Extra: guide
Requires-Dist: autodoc_pydantic; extra == "guide"
Requires-Dist: sphinx_design; extra == "guide"
Requires-Dist: pydata-sphinx-theme<0.17.0,>=0.16.1; extra == "guide"
Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
Requires-Dist: sphinx-automodapi; extra == "guide"
Requires-Dist: sphinx-copybutton; extra == "guide"
Requires-Dist: sphinx-prompt; extra == "guide"
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: sphinxext-opengraph; extra == "guide"
Requires-Dist: sphinxcontrib-jquery; extra == "guide"
Requires-Dist: sphinxext-rediraffe; extra == "guide"
Requires-Dist: sphinxcontrib-youtube; extra == "guide"
Requires-Dist: sphinx-favicon; extra == "guide"
Requires-Dist: sphinx-sitemap; extra == "guide"
Provides-Extra: technote
Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
Requires-Dist: sphinx-prompt; extra == "technote"
Requires-Dist: sphinxcontrib-mermaid>=1; extra == "technote"
Requires-Dist: sphinx-diagrams; extra == "technote"
Requires-Dist: sphinx_design; extra == "technote"
Requires-Dist: myst-nb; extra == "technote"
Requires-Dist: sphinxcontrib-youtube; extra == "technote"
Requires-Dist: sphinx-sitemap; extra == "technote"
Dynamic: license-file

[![Documentation](https://img.shields.io/badge/documenteer-lsst.io-brightgreen.svg)](https://documenteer.lsst.io)
[![PyPI](https://img.shields.io/pypi/v/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
[![For Python 3.12+](https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
[![MIT license](https://img.shields.io/pypi/l/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
[![CI](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml/badge.svg)](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)
[![Weekly CI](https://github.com/lsst-sqre/documenteer/actions/workflows/ci-cron.yaml/badge.svg)](https://github.com/lsst-sqre/documenteer/actions/workflows/ci-cron.yaml)

# Documenteer

Documenteer provides tools, extensions, and configurations for Rubin Observatory's Sphinx documentation projects, including [user guides](https://documenteer.lsst.io/guides/index.html) and [technotes](https://developer.lsst.io/project-docs/technotes.html).

For more information about Documenteer, see the documentation at https://documenteer.lsst.io.

Browse the [lsst-doc-engineering](https://github.com/topics/lsst-doc-engineering) GitHub topic for more Rubin Observatory documentation engineering projects.

## Quick installation:

For [user guides](https://documenteer.lsst.io/guides/index.html):

```sh
pip install "documenteer[guide]"
```

For [technical note projects](https://documenteer.lsst.io/technotes/index.html):

```sh
pip install "documenteer[technote]"
```
