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

Uploaded Source

Built Distribution

documenteer-1.2.1-py3-none-any.whl (820.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.2.1.tar.gz
Algorithm Hash digest
SHA256 87e858aabdf7418d379d9a2b6a94f3d11c2086fb3561cf028fd8ad7444fd4a7e
MD5 f7af594e45ce6f5013f8089511484dfa
BLAKE2b-256 cd2ff968c874a1273f581e3919f755baef8493d2fc92043f93f0b6dc6a45eff5

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for documenteer-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6587aaef2cc58062ea0145e1f6951ac3f9bc4f41a22104dfc93008314d9c0b1e
MD5 dec3ff4a794d1062e408454cd33494cc
BLAKE2b-256 c4628c8ec7f6fa99a8806ddc1dc51ebb8d1c768fe486360adea2745a48b77846

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