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

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.0a1.tar.gz (708.0 kB view details)

Uploaded Source

Built Distribution

documenteer-1.0.0a1-py3-none-any.whl (203.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.0.0a1.tar.gz
  • Upload date:
  • Size: 708.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for documenteer-1.0.0a1.tar.gz
Algorithm Hash digest
SHA256 b27ee8ad8f6ce8cf1b959f93ca6f158824baaee6eeea8d007bcea539031b3c6b
MD5 eaf81cbd711433685b6d4ca5b2414401
BLAKE2b-256 732fe09a140a46fa8dc975061f5f608397c67e98c417926aa80ca9c20d3eed92

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 efb0483e61143b4e4c29d4bdf42621dbddcf65f3763451058b352c8bb2d17db8
MD5 1169ab335de48e30d03d4937da6cb62b
BLAKE2b-256 a400e3a3a571609a233429291ae9d3bfaab42dbee627d7a743e0f1c31423b2ef

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