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

Uploaded Source

Built Distribution

documenteer-1.1.0-py3-none-any.whl (820.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.1.0.tar.gz
Algorithm Hash digest
SHA256 2f7fad467711c0ec0fff10fd9b00b6c0c6cfeec61bed9afb84004dd4b7e89765
MD5 5bdec0f4cd9be236897b812b7c8152fd
BLAKE2b-256 fe8889265d590db5a8ae81412186b964689cba35e12214f51549c34f758c4f9c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 820.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for documenteer-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7bf9cb3cb177ae90ded44ff0426b22f81c3012d635e319fe197385b5c5073f24
MD5 7b69d2a6922991c3402e346236009e5d
BLAKE2b-256 561cc0d85c5b151d2aaeec4546778e974bee1fb25ab5ec1de2fc99295ed4bcb9

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