Rubin Observatory's framework for Sphinx-based technote documents.
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file technote-0.3.0a3.tar.gz.
File metadata
- Download URL: technote-0.3.0a3.tar.gz
- Upload date:
- Size: 141.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 74086644c1fe25eb369d6f8714bcdb5c0bd89e312b57564249657e7604dc65a4 |
|
| MD5 | 1badc514fb4ed1b474d346dde8037f00 |
|
| BLAKE2b-256 | 2adfabdb3aee998e7ad3df96f685790db7fb9e0e43c5c43ce065174132df7e3c |
File details
Details for the file technote-0.3.0a3-py3-none-any.whl.
File metadata
- Download URL: technote-0.3.0a3-py3-none-any.whl
- Upload date:
- Size: 72.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f28072b6e991bebbb3096660d0428dfc169ae6deb59bf0f71de5cfba8f36bf40 |
|
| MD5 | 302b292defcc37c9748732a14266e56b |
|
| BLAKE2b-256 | 2b874da76a5a13b684541cc77a9ff5bc3888b17e0508d6ecaaa687951b3859e0 |
