Name | documenteer JSON |
Version |
2.3.0
JSON |
| download |
home_page | None |
Summary | Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations. |
upload_time | 2025-09-03 20:35:05 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.12 |
license | None |
keywords |
rubin
lsst
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
[](https://documenteer.lsst.io)
[](https://pypi.python.org/pypi/documenteer)
[](https://pypi.python.org/pypi/documenteer)
[](https://pypi.python.org/pypi/documenteer)
[](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)
[](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/d8/34/917a21070b6d2ea33000f58c406f7778a085bce2987eba83dcf9f9f5eaeb/documenteer-2.3.0.tar.gz",
"platform": null,
"description": "[](https://documenteer.lsst.io)\n[](https://pypi.python.org/pypi/documenteer)\n[](https://pypi.python.org/pypi/documenteer)\n[](https://pypi.python.org/pypi/documenteer)\n[](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)\n[](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.3.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": "0c4a408c64b720ac891fd665af6eb0af25606a238ec3c3c698dbdd52e6e38923",
"md5": "e6ecfb83da1117018a7b7d05bfb8a982",
"sha256": "ee154d7fa366565faaeb8aae0799a07005cc630dd477993eca72fbde00c65018"
},
"downloads": -1,
"filename": "documenteer-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6ecfb83da1117018a7b7d05bfb8a982",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 705724,
"upload_time": "2025-09-03T20:35:03",
"upload_time_iso_8601": "2025-09-03T20:35:03.964790Z",
"url": "https://files.pythonhosted.org/packages/0c/4a/408c64b720ac891fd665af6eb0af25606a238ec3c3c698dbdd52e6e38923/documenteer-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d834917a21070b6d2ea33000f58c406f7778a085bce2987eba83dcf9f9f5eaeb",
"md5": "98f6f967ad726a028b840f67b27f09e7",
"sha256": "24687448174c3cb0382d064aa2e71b25200520200ea8f230cc19c28f7f2f11c2"
},
"downloads": -1,
"filename": "documenteer-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "98f6f967ad726a028b840f67b27f09e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 1271750,
"upload_time": "2025-09-03T20:35:05",
"upload_time_iso_8601": "2025-09-03T20:35:05.372269Z",
"url": "https://files.pythonhosted.org/packages/d8/34/917a21070b6d2ea33000f58c406f7778a085bce2987eba83dcf9f9f5eaeb/documenteer-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-03 20:35:05",
"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"
}