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

Uploaded Source

Built Distribution

documenteer-1.0.0a2-py3-none-any.whl (204.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.0.0a2.tar.gz
Algorithm Hash digest
SHA256 44f9fdb91c34b201009ce64f66bb3569a939adc85babd99c084c9419dc1d62a8
MD5 35e00596a05a156953f1b7637d2678f2
BLAKE2b-256 869afe160126f7e58259a84d5dee93edb7b0f50f51ade7ad80bae6e1acaec9e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 74c92492e112428452f1ab2bfed5548b8c6ddd00c0f4ad01974d42fbb69d95e4
MD5 d09a35707b085325c37f7a46a6e35a58
BLAKE2b-256 6ddaf48352c80d8c00fd8d9d8f5c1511a6f4f4f88f1d1f8cf7433f6de0022920

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