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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.0.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.0.0.tar.gz
Algorithm Hash digest
SHA256 6d6f1f97fa7636591c8cb885fadce6055fe5e57a0b694182ac9980d9fd2f69a6
MD5 15f0651a345fe175bea1c92e861bf927
BLAKE2b-256 11005f460d82240fd7a465db57b72cebb51c4b42e544db88ef6aa42bbe14eed6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-1.0.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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 76b0e074833ac3941e4479fa79982f32b09e60fc1c6993e8749b99c9c4f8e1de
MD5 f80307a35f82972bd03983c744c44a07
BLAKE2b-256 90407cb36b18fbd048bbd44c731097628ac06207382e2ee486dc844f9e303272

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