Skip to main content

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

See the docs for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

technote-0.3.0a2.tar.gz (132.5 kB view details)

Uploaded Source

Built Distribution

technote-0.3.0a2-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

Details for the file technote-0.3.0a2.tar.gz.

File metadata

  • Download URL: technote-0.3.0a2.tar.gz
  • Upload date:
  • Size: 132.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for technote-0.3.0a2.tar.gz
Algorithm Hash digest
SHA256 a0aec92c91f29823286de7ec8b0bc8948f9bd252a9e7bbc75e7f8857149a0540
MD5 5e6253f4843f81160abeb8ffca673433
BLAKE2b-256 28c21772903db2ef4b7636dd5484c7dd3b0cbb77b0c28af8a3c96936e34072b0

See more details on using hashes here.

File details

Details for the file technote-0.3.0a2-py3-none-any.whl.

File metadata

  • Download URL: technote-0.3.0a2-py3-none-any.whl
  • Upload date:
  • Size: 61.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for technote-0.3.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 209b11b47cea96ba4ca4a1c8045977f27f729136644383a35ceaf0afafa13455
MD5 2b547acefd5d02311e6e0c5cad46a97e
BLAKE2b-256 1c17b3976fcb297db19c7ffd25086c3f7b2f8a80da5edd2609b7f10ab4cca71c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page