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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.0.0a15.tar.gz
  • Upload date:
  • Size: 704.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for documenteer-1.0.0a15.tar.gz
Algorithm Hash digest
SHA256 caa258ec5f5f68dca976e56098fa0d8a15974566ecca1df6962419ea27063c27
MD5 df42d7afd1a698346b238d6dae54495d
BLAKE2b-256 b35fe27767c9aaa1ab5a8f8f9521e2e4750a9118ef1aefea12e926472ca9167d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.0a15-py3-none-any.whl
Algorithm Hash digest
SHA256 9590ba12c6aca7f76faef5605070059113b1d0a801875f42e69444848c3746ec
MD5 51efcc26996148d079ba940e012e4eb6
BLAKE2b-256 6e567a3a89d8959bc886ba431c9c100e3fe37e9fee9e42fdbd968e55c16cf499

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