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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-0.8.0.tar.gz
  • Upload date:
  • Size: 631.9 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.0.tar.gz
Algorithm Hash digest
SHA256 0fefe09515857d30742e756c033ae5b58e55184aea255e713fd1f5e31e1142c0
MD5 075b4c123d977f26ffd6f836153fa9bb
BLAKE2b-256 a4f61fed5041495f559be87965444f2468a99326a8cce0f4df4749849abf379e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-0.8.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 37d935b7afda541787aaf40eca904db15eaf3a1c02aa2344c9a4d3ed98ecf067
MD5 4da0a514130a3d3a92dfa3876b51fb51
BLAKE2b-256 48e4700068b44f81b8583a3e1ac3afa6cf4a06194759fb0f1c9f10ce525ac53f

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