| Name | documenteer JSON |
| Version |
1.2.2
JSON |
| download |
| home_page | None |
| Summary | Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations. |
| upload_time | 2024-04-11 19:23:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | The MIT License (MIT) Copyright (c) 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 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, [user guides](https://documenteer.lsst.io/guides/index.html), [technotes](https://developer.lsst.io/project-docs/technotes.html) and EUPS-packaged stacks (such as the [LSST Science Pipelines](https://pipelines.lsst.io)).
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]"
```
For the [stack projects](https://documenteer.lsst.io/pipelines/index.html) (such as the [LSST Science Pipelines](https://pipelines.lsst.io)):
```sh
pip install "documenteer[pipelines]"
```
Raw data
{
"_id": null,
"home_page": null,
"name": "documenteer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "rubin, lsst",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0f/98/1107c418b670a822275579dbdb31dd1bb92434bede264c393590c0dfa3b4/documenteer-1.2.2.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, [user guides](https://documenteer.lsst.io/guides/index.html), [technotes](https://developer.lsst.io/project-docs/technotes.html) and EUPS-packaged stacks (such as the [LSST Science Pipelines](https://pipelines.lsst.io)).\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\nFor the [stack projects](https://documenteer.lsst.io/pipelines/index.html) (such as the [LSST Science Pipelines](https://pipelines.lsst.io)):\n\n```sh\npip install \"documenteer[pipelines]\"\n```\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://documenteer.lsst.io",
"Source": "https://github.com/lsst-sqre/documenteer"
},
"split_keywords": [
"rubin",
" lsst"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31d41dcd3a08dbe44e1d10b38fc7e19bb87b3ca7197e4b1f21595770ed8aba26",
"md5": "8e08d68d89f87eec00103fd54d83b12e",
"sha256": "13502e59f5382c686766f39291ab289956b31c91b4f7682c6702704e246f9fa8"
},
"downloads": -1,
"filename": "documenteer-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e08d68d89f87eec00103fd54d83b12e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 820316,
"upload_time": "2024-04-11T19:23:50",
"upload_time_iso_8601": "2024-04-11T19:23:50.644350Z",
"url": "https://files.pythonhosted.org/packages/31/d4/1dcd3a08dbe44e1d10b38fc7e19bb87b3ca7197e4b1f21595770ed8aba26/documenteer-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f981107c418b670a822275579dbdb31dd1bb92434bede264c393590c0dfa3b4",
"md5": "daf9b5b7bd11d2332031e48a4df31f3f",
"sha256": "c0661cd6b1c3b0179fab505757c46dd7d46106b92b3ec4e800d512fd67a95477"
},
"downloads": -1,
"filename": "documenteer-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "daf9b5b7bd11d2332031e48a4df31f3f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 1369850,
"upload_time": "2024-04-11T19:23:53",
"upload_time_iso_8601": "2024-04-11T19:23:53.263466Z",
"url": "https://files.pythonhosted.org/packages/0f/98/1107c418b670a822275579dbdb31dd1bb92434bede264c393590c0dfa3b4/documenteer-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 19:23:53",
"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"
}
