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

Uploaded Source

Built Distribution

documenteer-1.4.0-py3-none-any.whl (820.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.4.0.tar.gz
Algorithm Hash digest
SHA256 759fdbf4554449a74df9fb10cfe91984bc1272f0a2c6c688817d1a2525c72881
MD5 02050a8d9588e30ce609d5fe2806389e
BLAKE2b-256 5ac1e4bbab1afe453e0ab3a735b8acc2081b43ed09bc15aa457c97e509e177fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 820.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for documenteer-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e456e21cb6d0be659b5297de87cb3e60d9bf0fffb63e316dbaba20b38a5f70ee
MD5 c5f66b27d8c086914706181d1120e498
BLAKE2b-256 66f95eeb0297d6875bd1378bf50019d1dea1f4665effbf2c0709a218c0bfbb4b

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