| Name | technote JSON |
| Version |
0.9.1
JSON |
| download |
| home_page | None |
| Summary | Rubin Observatory's framework for Sphinx-based technote documents. |
| upload_time | 2025-07-25 16:40:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| 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": null,
"name": "technote",
"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/3d/e3/8b1dca2c0c15a1b87b384fb7476da3eb529763e5cd5b7ed22c2b8999cd46/technote-0.9.1.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": null,
"summary": "Rubin Observatory's framework for Sphinx-based technote documents.",
"version": "0.9.1",
"project_urls": {
"Homepage": "https://technote.lsst.io",
"Source": "https://github.com/lsst-sqre/technote"
},
"split_keywords": [
"rubin",
" lsst"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b937ebda052744ebfe1b3db38647a299283ec4ec710041ebdd05d76dd74614d2",
"md5": "50509e1fdf79dbfec2e096cf1b138301",
"sha256": "73b89541a5e2c036fe97b474bffa17ae1d53de77ba8e033dccce111b5d860c73"
},
"downloads": -1,
"filename": "technote-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "50509e1fdf79dbfec2e096cf1b138301",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 99399,
"upload_time": "2025-07-25T16:40:12",
"upload_time_iso_8601": "2025-07-25T16:40:12.352694Z",
"url": "https://files.pythonhosted.org/packages/b9/37/ebda052744ebfe1b3db38647a299283ec4ec710041ebdd05d76dd74614d2/technote-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3de38b1dca2c0c15a1b87b384fb7476da3eb529763e5cd5b7ed22c2b8999cd46",
"md5": "f111fd584411290791a34328c7296b8b",
"sha256": "883eaef35a03b8c04df046d4fba3c0247b9636cc8c7971bb15fbd840b527deb7"
},
"downloads": -1,
"filename": "technote-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "f111fd584411290791a34328c7296b8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 564838,
"upload_time": "2025-07-25T16:40:13",
"upload_time_iso_8601": "2025-07-25T16:40:13.564008Z",
"url": "https://files.pythonhosted.org/packages/3d/e3/8b1dca2c0c15a1b87b384fb7476da3eb529763e5cd5b7ed22c2b8999cd46/technote-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 16:40:13",
"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"
}
