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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.0.1a1.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.1a1.tar.gz
Algorithm Hash digest
SHA256 961860a3d929d881630ca52d07b3aeba8aadef70a33d161e5c0468793203b804
MD5 07efc68497eadb9a2088489364f2629d
BLAKE2b-256 c1803c1ff4b25e2c610fcc84fecfa3a935233e5e7c3395c40dd58a732a70a001

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 c85da13ac669d6f54bac24caf6645b361545a927067aa8050d6a57d2ae30c059
MD5 b65808af0a97e2de46c68685e7a90619
BLAKE2b-256 4b9cb7cf56dd99eaa85d4d7a00151d445444fca82bc4151d89486eeab9660e62

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