| Name | technote JSON |
| Version |
0.7.0
JSON |
| download |
| home_page | |
| Summary | Rubin Observatory's framework for Sphinx-based technote documents. |
| upload_time | 2024-01-30 22:32:40 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 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://doi.org/10.5281/zenodo.10385500)
[](https://github.com/lsst-sqre/technote/actions/workflows/ci.yaml)
# Technote
Rubin Observatory's framework for Sphinx-based technote documents.
Learn more at https://technote.lsst.io.
Install from PyPI:
```sh
pip install technote
```
technote is developed by Rubin Observatory at https://github.com/lsst-sqre/technote.
## Features
> **Warning**
> Technote is in initial design and development.
> The features described below may not be implemented yet.
*Technotes* are web-native, single page websites that facilitate rapid scientific and technical communication.
The "technote" package provides the framework for creating technotes:
- A Sphinx theme optimized for single page documents, like technotes.
This theme can be customized by organizations.
- A `technote.toml` makes it easy to configure document metadata.
- Technotes can be written in reStructuredText, Markdown, or as Jupyter notebooks.
## Developing technote
The best way to start contributing to technote is by cloning this repository, creating a virtual environment, and running the `make init` command to set up the Python project:
```sh
git clone https://github.com/lsst-sqre/technote.git
cd technote
make init
```
Technote also uses [Webpack](https://webpack.js.org/) to bundle CSS and JS.
We use [nvm](https://github.com/nvm-sh/nvm) to set up Node at a specific version:
```sh
nvm use
```
This may happen automatically when opening the technote repo in your shell.
Then install the JS dependencies:
```sh
npm install
```
And build the CSS and JS assets:
```sh
npm run build
```
You can run tests and build documentation with [tox](https://tox.wiki/en/latest/):
```sh
tox
```
To learn more about the individual environments:
```sh
tox -av
```
In particular, to build a demo technote in the [demo](./demo) directory:
```sh
tox -e demo
```
[See the docs for more information.](https://technote.lsst.io/dev/development.html)
Raw data
{
"_id": null,
"home_page": "",
"name": "technote",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "rubin,lsst",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8d/32/dd1b46807441951fb357bddd62aa9bfda4fd5b1c32f6c8b5d25449ca51df/technote-0.7.0.tar.gz",
"platform": null,
"description": "[](https://doi.org/10.5281/zenodo.10385500)\n[](https://github.com/lsst-sqre/technote/actions/workflows/ci.yaml)\n\n# Technote\n\nRubin Observatory's framework for Sphinx-based technote documents.\nLearn more at https://technote.lsst.io.\n\nInstall from PyPI:\n\n```sh\npip install technote\n```\n\ntechnote is developed by Rubin Observatory at https://github.com/lsst-sqre/technote.\n\n## Features\n\n> **Warning**\n> Technote is in initial design and development.\n> The features described below may not be implemented yet.\n\n*Technotes* are web-native, single page websites that facilitate rapid scientific and technical communication.\nThe \"technote\" package provides the framework for creating technotes:\n\n- A Sphinx theme optimized for single page documents, like technotes.\n This theme can be customized by organizations.\n- A `technote.toml` makes it easy to configure document metadata.\n- Technotes can be written in reStructuredText, Markdown, or as Jupyter notebooks.\n\n## Developing technote\n\nThe best way to start contributing to technote is by cloning this repository, creating a virtual environment, and running the `make init` command to set up the Python project:\n\n```sh\ngit clone https://github.com/lsst-sqre/technote.git\ncd technote\nmake init\n```\n\nTechnote also uses [Webpack](https://webpack.js.org/) to bundle CSS and JS.\nWe use [nvm](https://github.com/nvm-sh/nvm) to set up Node at a specific version:\n\n```sh\nnvm use\n```\n\nThis may happen automatically when opening the technote repo in your shell.\n\nThen install the JS dependencies:\n\n```sh\nnpm install\n```\n\nAnd build the CSS and JS assets:\n\n```sh\nnpm run build\n```\n\nYou can run tests and build documentation with [tox](https://tox.wiki/en/latest/):\n\n```sh\ntox\n```\n\nTo learn more about the individual environments:\n\n```sh\ntox -av\n```\n\nIn particular, to build a demo technote in the [demo](./demo) directory:\n\n```sh\ntox -e demo\n```\n\n[See the docs for more information.](https://technote.lsst.io/dev/development.html)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 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's framework for Sphinx-based technote documents.",
"version": "0.7.0",
"project_urls": {
"Homepage": "https://technote.lsst.io",
"Source": "https://github.com/lsst-sqre/technote"
},
"split_keywords": [
"rubin",
"lsst"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19490226cb8693dc5bd632746f771364b2759c5defbc2eaec27e7821c728c658",
"md5": "185c3f4330d10ad37003a8e3954fa277",
"sha256": "e40584e59c5b1a69a7d697a614a0f8e20507aae3718588110aacc94ba52a8983"
},
"downloads": -1,
"filename": "technote-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "185c3f4330d10ad37003a8e3954fa277",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 86100,
"upload_time": "2024-01-30T22:32:39",
"upload_time_iso_8601": "2024-01-30T22:32:39.246486Z",
"url": "https://files.pythonhosted.org/packages/19/49/0226cb8693dc5bd632746f771364b2759c5defbc2eaec27e7821c728c658/technote-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d32dd1b46807441951fb357bddd62aa9bfda4fd5b1c32f6c8b5d25449ca51df",
"md5": "346b2ab5d2d0f31952eef8efa30a310f",
"sha256": "c49aef71ec5e84a2da5011268bda66ae30b3197b95cd582eb843100b1e68fd6b"
},
"downloads": -1,
"filename": "technote-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "346b2ab5d2d0f31952eef8efa30a310f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 553848,
"upload_time": "2024-01-30T22:32:40",
"upload_time_iso_8601": "2024-01-30T22:32:40.724154Z",
"url": "https://files.pythonhosted.org/packages/8d/32/dd1b46807441951fb357bddd62aa9bfda4fd5b1c32f6c8b5d25449ca51df/technote-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 22:32:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lsst-sqre",
"github_project": "technote",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "technote"
}
