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

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-0.8.2.tar.gz (632.0 kB view details)

Uploaded Source

Built Distribution

documenteer-0.8.2-py3-none-any.whl (186.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-0.8.2.tar.gz
Algorithm Hash digest
SHA256 30dcd20bb353b5389c5e7578c1eb13edc163c27cec6270bfe3c938eb51d8c164
MD5 46139ef824ddc7434a1061cd0e5fbf09
BLAKE2b-256 912564ceeb4f0324d30b52952f7d4abe0f09ee0880efaa95acf7c0ba05a2c3a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 186.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for documenteer-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3880ed4b8411dd15e4aae19136f0a39f305464adbaa05c8a3d5055385f7e41f9
MD5 228cb98984dc6973bd36648676beee78
BLAKE2b-256 0cbf4f1ac8d6846b704f8c0c5ff34f14fbf82e73c2682d6c3db84e7f1ab71fda

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