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
Metadata
Release files for technote 0.12.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 | Provenance | Actions |
|---|---|---|---|---|
| technote-0.12.0.tar.gz | 600.0 kB | Without provenance | Details for technote-0.12.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| technote-0.12.0-py3-none-any.whl | Python 3 | none | any | Details for technote-0.12.0-py3-none-any.whl |
Total release size: 715.4 kB
Release files / technote-0.12.0.tar.gz
| Download URL | technote-0.12.0.tar.gz |
|---|---|
| Size | 600.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c603c44a5fed81355220d443463db176121bc2cd419d7c4d7b7385c1960fbf35
|
|
BLAKE2b-256 checksum How to use checksums |
2a802539f888278bd7e706be44f22837aec09be114c00d9d5a340d5ca1c29fcc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","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.12.0-py3-none-any.whl
| Download URL | technote-0.12.0-py3-none-any.whl |
|---|---|
| Size | 115.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7e2eedd2101cd8f245a851c69f166f4e9ee5f259d44779eb83a32ede05b0ce02
|
|
BLAKE2b-256 checksum How to use checksums |
28be379da31600d7bc67b2ec84c543218dc2c8e394768abd1401817b0c158f68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","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}
|
Security for technote 0.12.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.