Technote
Rubin Observatory's framework for Sphinx-based technote documents. Learn more at https://technote.lsst.io.
Install from PyPI:
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.tomlmakes 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:
git clone https://github.com/lsst-sqre/technote.git
cd technote
make init
Technote also uses Webpack to bundle CSS and JS. We use nvm to set up Node at a specific version:
nvm use
This may happen automatically when opening the technote repo in your shell.
Then install the JS dependencies:
npm install
And build the CSS and JS assets:
npm run build
You can run tests and build documentation with tox:
tox
To learn more about the individual environments:
tox -av
In particular, to build a demo technote in the demo directory:
tox -e demo
2 maintainers
Metadata
2 maintainers
Release files for technote 0.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| technote-0.10.0.tar.gz | 579.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| technote-0.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 685.8 kB
Release files / technote-0.10.0.tar.gz
| Download URL | technote-0.10.0.tar.gz |
|---|---|
| Size | 579.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c5c2516059256b9716bcb85095ce818f65dd761a5fb5292bb87cf580c01da2a7
|
|
BLAKE2b-256 checksum How to use checksums |
5fd665d6891c2eec214b8eef86fafd73a621081399caf4076db086ff22e9dc16
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / technote-0.10.0-py3-none-any.whl
| Download URL | technote-0.10.0-py3-none-any.whl |
|---|---|
| Size | 106.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d16ff9002947980be08fa8196823ca9cf51cbd676792376268d66edb88bbbc72
|
|
BLAKE2b-256 checksum How to use checksums |
2a52940d330a3f57b3304898a516d6bfbb9d2a786a8fa251a8efdbfc9890fa58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
