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.0.1

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 d581fb54b6205daec69b4515b5a71e15781dfff1c2dd1f59fa28de1d2b2d4eb9
MD5 4cbd3b1362490f1c1f6cdc5de12541f9
BLAKE2b-256 fa9361e1580283eb9cddbb465fc7d3586cd6b4b13bdb97c1702b31d7f5ea918e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-1.0.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d6bf2947456fd3456d86790874d7aab24c8f33d5b69a1f4d40bfb88a714f900
MD5 86d1c650d13bd7194afbee2c8be8a2a4
BLAKE2b-256 d1944f7d8faf34df2966b742d05d750181fab0f9e3a76c67ee98830134be6910

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