Skip to main content

Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.

Project description

Documentation PyPI For Python 3.7+ MIT license CI Weekly CI

Documenteer

Documenteer provides tools, extensions, and configurations for Rubin Observatory's Sphinx documentation projects, user guides, technotes and EUPS-packaged stacks (such as the LSST Science Pipelines).

For more information about Documenteer, see the documentation at https://documenteer.lsst.io.

Browse the lsst-doc-engineering GitHub topic for more Rubin Observatory documentation engineering projects.

Quick installation:

For user guides:

pip install "documenteer[technote]"

For technical note projects:

pip install "documenteer[technote]"

For the stack projects (such as the LSST Science Pipelines):

pip install "documenteer[pipelines]"

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

documenteer-0.8.0b1.tar.gz (701.8 kB view details)

Uploaded Source

Built Distribution

documenteer-0.8.0b1-py3-none-any.whl (201.7 kB view details)

Uploaded Python 3

File details

Details for the file documenteer-0.8.0b1.tar.gz.

File metadata

  • Download URL: documenteer-0.8.0b1.tar.gz
  • Upload date:
  • Size: 701.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for documenteer-0.8.0b1.tar.gz
Algorithm Hash digest
SHA256 90858223c70a74982496b7c0a22470063ffd8ad1e694bf43b44919980dea0169
MD5 bd4267cf797fa32c3bf02f81a57302f4
BLAKE2b-256 fbfd74904a63a235f01dfb1a296d243f5336141ab1c7cd02c73f3c9cf3cb412b

See more details on using hashes here.

File details

Details for the file documenteer-0.8.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for documenteer-0.8.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 807324b600687375f1a18ec81558468408a1b8d9d0f4b63012cb45b6b73c310d
MD5 d2cb85cd6389584dab8c3a02ebc2f8a5
BLAKE2b-256 0ff73ec24d9add2137dd0763a563420084ea344c9c3a8285c1c314e1368caab2

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