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

Uploaded Source

Built Distribution

documenteer-1.2.0-py3-none-any.whl (820.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.2.0.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for documenteer-1.2.0.tar.gz
Algorithm Hash digest
SHA256 6a907f35036d4d4601eede8a4102dcd3e4e80566ee67b43388b01f8db40960bb
MD5 3e26974e918023da6e719a72cba89a42
BLAKE2b-256 79972473cfd17802e79989a2f640bbfc38ad69e5a8dd2ef18a25a421ac42414c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 820.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for documenteer-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4097a8389bc20b1337ff3588c6f069a4b0c3d23306d71454449ef4144c696d02
MD5 c4910b534269d5012317b9b8460631d5
BLAKE2b-256 bd5fe04e36bb5fb3664a39cc1b5ba6b6f7e791e1da73fe0e70f8c4e804651de7

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