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

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.1.tar.gz (632.0 kB view details)

Uploaded Source

Built Distribution

documenteer-0.8.1-py3-none-any.whl (186.3 kB view details)

Uploaded Python 3

File details

Details for the file documenteer-0.8.1.tar.gz.

File metadata

  • Download URL: documenteer-0.8.1.tar.gz
  • Upload date:
  • Size: 632.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for documenteer-0.8.1.tar.gz
Algorithm Hash digest
SHA256 de0ac8de6ba7cd8533a81fc5bb4cdf41ec1c06a17600488bde89266e1680b196
MD5 de24ed8715779ac6d584e0a7708d7ec7
BLAKE2b-256 ed5ba5373955306123422dc8084b260d36d82bdf16628039aabf35817c55abd3

See more details on using hashes here.

File details

Details for the file documenteer-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: documenteer-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 186.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for documenteer-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c1e4975a113cab5b781ba1eed2e7e65b7282e6f0de6c3e0a0bae042076b39fbc
MD5 dadbc3a45c62fb11af81b1e5c89ffc06
BLAKE2b-256 f1d5687439e22527e74a6154bce6bb656951c791b93a78063b4db62eeafdaed6

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