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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.0.0a6.tar.gz
Algorithm Hash digest
SHA256 df70fe65304be78cf5fc3f838f95f87d4cd2b4b63edba89946ef180cf3ae66bc
MD5 044d83f33abf271bbec15cd310ce670d
BLAKE2b-256 852747e21318bfd24a6028abf1616a3f6b042b61ac0ffd6b8e54c5dba09486d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.0a6-py3-none-any.whl
Algorithm Hash digest
SHA256 c33eb7bb4bc76ac023e0f3a4dc0415c60512f22bb3fff247758cfb91d190dd59
MD5 2cb607fc0eeeb3dede2aac2e84852591
BLAKE2b-256 5fb95a723b2e25bee8f65328d74a277569c497b88edd0727fd8402bb65e09235

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