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.0a17.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

documenteer-1.0.0a17-py3-none-any.whl (820.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.0.0a17.tar.gz
Algorithm Hash digest
SHA256 e1c5d924cdb33e9a28f74dd8d50d01183bbdb9914f88de35e55e3e8ae09c40b5
MD5 564a9593fe8d86781b16611a1db7b466
BLAKE2b-256 4012232f13cff7aace3088b3c2c935091bf61221a1cf03b5f98e88867b81c974

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.0a17-py3-none-any.whl
Algorithm Hash digest
SHA256 c84eacc51eae434f87d0d381b38ae5985f5078c45a6672d85c323f6658c3efa0
MD5 1e68f20e273e14419fc8668b4f89a486
BLAKE2b-256 172630bad4a5d762c59b0a2da7b01097cb0aa9352123b422087016a7ddfcb38b

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