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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.1.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.8

File hashes

Hashes for documenteer-1.1.1.tar.gz
Algorithm Hash digest
SHA256 547232b01111de8b88afa6347e376b524b08b93c7ef4b4364b09ecd7ab118c8f
MD5 1ce7a4d4431ee2cead66e2ae849a5a9f
BLAKE2b-256 4e75b8caee8048cc791478a67bbbf1d61a4d967606eccb359273d1e7ad661fe4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-1.1.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.8

File hashes

Hashes for documenteer-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 398b7aec72dbc5a073b8b83e632384ecbba3dccc3f373ff15a98459f95aa7396
MD5 ce00b5d8595f6d59eb0bef07685d38fa
BLAKE2b-256 a62c556c047420a3fec1ba9a4bda555a98d9d28499add548abb0f19d395472f6

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