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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.0.0a18.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.0a18.tar.gz
Algorithm Hash digest
SHA256 6a3b4123eef3f8d5cbb8168b2cc897d95c590a0f280e0bff8b46da89c4257772
MD5 e96b0573f2eb78e715b54e7c34dc035d
BLAKE2b-256 b07f941c0ab2051e430b4bcb739727ab701a1bbd4a9ba46355c5721c6f8d1a4b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.0a18-py3-none-any.whl
Algorithm Hash digest
SHA256 25f20e46408b4188f54d958557fc206512102425d72742bb6a46d57d032f6dff
MD5 0e232d64093c6c8f23833a036a7b456a
BLAKE2b-256 b3cb822807bac61cc0a0d772f15a92d1c3d72bcb8c65e9ef3a4fd49c9d6831c5

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