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

Uploaded Source

Built Distribution

documenteer-1.4.2-py3-none-any.whl (820.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.4.2.tar.gz
Algorithm Hash digest
SHA256 89756cf2026c3e70a36b9d2ecb69c38d58c320554f498be5955ddc815de4b035
MD5 5288ac030cb21e9617a1bf9b29e50e28
BLAKE2b-256 8f55473a583e2d6fc2e099ee8ab8354f797abddc5aff942302a74a654493a95c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 820.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for documenteer-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 03a4cf3b8ffa4905c59662131f87afe77417238f10e9f01075d849f08a32e99d
MD5 c6dc1a53a588b6e145671c870cb48d99
BLAKE2b-256 a5af174d00bced5f249d43e0ac543d0a8f49112a8b9ab37fd22ad94fe72471aa

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