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[guide]"

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-1.0.0a16.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

documenteer-1.0.0a16-py3-none-any.whl (806.4 kB view details)

Uploaded Python 3

File details

Details for the file documenteer-1.0.0a16.tar.gz.

File metadata

  • Download URL: documenteer-1.0.0a16.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for documenteer-1.0.0a16.tar.gz
Algorithm Hash digest
SHA256 188d3d48394f30e204526324cbd62d0fa930465f91d4519cca0e97aa57afe64c
MD5 956c3ec4e010c219a40096b405a0b020
BLAKE2b-256 0ec49d773a3eacf2a62b55ae8d52acabb968f04342c3bd72a7580f89c871ad65

See more details on using hashes here.

File details

Details for the file documenteer-1.0.0a16-py3-none-any.whl.

File metadata

File hashes

Hashes for documenteer-1.0.0a16-py3-none-any.whl
Algorithm Hash digest
SHA256 2c4a588a0647955e0c711c85b871bd4a279126940eb4d00a944c4a37deef57c9
MD5 d9aabfe02576b647aad77fd111ff5496
BLAKE2b-256 44428e3460c3077f4a0e2492bf39e880dc8abf5d8157527204d08776d5dcac05

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