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.0a8.tar.gz (706.6 kB view details)

Uploaded Source

Built Distribution

documenteer-1.0.0a8-py3-none-any.whl (196.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.0.0a8.tar.gz
  • Upload date:
  • Size: 706.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for documenteer-1.0.0a8.tar.gz
Algorithm Hash digest
SHA256 566126dd8c798b4b4a282580b372c1b814f189f0d6a9f25b9ff1aebdd3353a0f
MD5 04c2cc64f05294c31fb4f484420bd28c
BLAKE2b-256 1d43bdf3aa3150f2e917ca8f3982eb38b4731a71afc582da34d5567de4fa5a93

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 a7889bfb8f246e01ce1af508aeb477312d4885f4ecc33fdd89ddbfaeacab5208
MD5 eed45013a1cad177a5b8fa978fffeac6
BLAKE2b-256 30c94d70a37f6f7858f66601210f0bc6528339cae6c0d9dab76ece324f8a21bc

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