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.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:
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
Project details
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
Hashes for technote-0.2.0a4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0203af94bbbb1c817433e4675e431f701a56c6fc9e7afaddbfcfd055dddec81 |
|
MD5 | cfd518a46c4e0703081bd1ac2708244b |
|
BLAKE2b-256 | 98e27311d88d69a27663b2c69cd0600dd3115df336bb68f42391da51d6ad58b0 |