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

This version

1.3.0

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

Uploaded Source

Built Distribution

documenteer-1.3.0-py3-none-any.whl (821.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.3.0.tar.gz
Algorithm Hash digest
SHA256 b598b415d5662ae2b7ee3e17a0c5ed6b99dbe93d4442e314e892277624040a78
MD5 fafe33d56f8f812687b10f39586f9358
BLAKE2b-256 303ab10471934f47a6e27e3a048afe6d8fce294017a5ea1320798c3c35bc01f6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 821.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for documenteer-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5930e3c6ef9ee1b7c49db280925a34451bd4b7d1dd9c9601f690d700e2337010
MD5 93ff4affb72fcd8d18e34d19ae031e32
BLAKE2b-256 7b93f9a0503777d63bb01edcc58594ffe0d559d0b894f88b14cf501ebb337873

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