documenteer


Namedocumenteer JSON
Version 2.0.0 PyPI version JSON
download
home_pageNone
SummaryRubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
upload_time2025-07-10 21:17:13
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseNone
keywords rubin lsst
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![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]"
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "documenteer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "rubin, lsst",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/e8/ac/ef2c24b58e78873cfe853dbe07eacd31014896a8703297575fd70fe2eca4/documenteer-2.0.0.tar.gz",
    "platform": null,
    "description": "[![Documentation](https://img.shields.io/badge/documenteer-lsst.io-brightgreen.svg)](https://documenteer.lsst.io)\n[![PyPI](https://img.shields.io/pypi/v/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)\n[![For Python 3.12+](https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)\n[![MIT license](https://img.shields.io/pypi/l/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)\n[![CI](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml/badge.svg)](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)\n[![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)\n\n# Documenteer\n\nDocumenteer 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).\n\nFor more information about Documenteer, see the documentation at https://documenteer.lsst.io.\n\nBrowse the [lsst-doc-engineering](https://github.com/topics/lsst-doc-engineering) GitHub topic for more Rubin Observatory documentation engineering projects.\n\n## Quick installation:\n\nFor [user guides](https://documenteer.lsst.io/guides/index.html):\n\n```sh\npip install \"documenteer[guide]\"\n```\n\nFor [technical note projects](https://documenteer.lsst.io/technotes/index.html):\n\n```sh\npip install \"documenteer[technote]\"\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.",
    "version": "2.0.0",
    "project_urls": {
        "Homepage": "https://documenteer.lsst.io",
        "Source": "https://github.com/lsst-sqre/documenteer"
    },
    "split_keywords": [
        "rubin",
        " lsst"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "79031012983610dcaf085a12a9e899e357dc6d205018c25df0881858b1aab93b",
                "md5": "45d59609d9eb5c9c592098d4beda7488",
                "sha256": "3f82f6261930fc06b6f1de59c8ddf6f0d32dc3b67f339be3ab7ec2152e71d379"
            },
            "downloads": -1,
            "filename": "documenteer-2.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "45d59609d9eb5c9c592098d4beda7488",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 701995,
            "upload_time": "2025-07-10T21:17:12",
            "upload_time_iso_8601": "2025-07-10T21:17:12.348547Z",
            "url": "https://files.pythonhosted.org/packages/79/03/1012983610dcaf085a12a9e899e357dc6d205018c25df0881858b1aab93b/documenteer-2.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e8acef2c24b58e78873cfe853dbe07eacd31014896a8703297575fd70fe2eca4",
                "md5": "5b2d09b982b1f6a3524a7f95fddeb85d",
                "sha256": "f7520bfbca2f7f09a53b8326e1b9ed04fcfdf1715088dc21ecd61b4830eb703d"
            },
            "downloads": -1,
            "filename": "documenteer-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5b2d09b982b1f6a3524a7f95fddeb85d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 1261858,
            "upload_time": "2025-07-10T21:17:13",
            "upload_time_iso_8601": "2025-07-10T21:17:13.653431Z",
            "url": "https://files.pythonhosted.org/packages/e8/ac/ef2c24b58e78873cfe853dbe07eacd31014896a8703297575fd70fe2eca4/documenteer-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 21:17:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "lsst-sqre",
    "github_project": "documenteer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "documenteer"
}
        
Elapsed time: 1.87917s