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.0a12.tar.gz (703.5 kB view details)

Uploaded Source

Built Distribution

documenteer-1.0.0a12-py3-none-any.whl (184.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-1.0.0a12.tar.gz
  • Upload date:
  • Size: 703.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for documenteer-1.0.0a12.tar.gz
Algorithm Hash digest
SHA256 ac80a724b287b41d48e1f63cabc98fe91c0aee13ea48ebec710ec79c6295cfe2
MD5 fc95fc625694a63afd5d4cf78c6da349
BLAKE2b-256 865654c4c8169875ed011dad5ed769d22497d2eff64ac906151caf1ff0909714

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-1.0.0a12-py3-none-any.whl
Algorithm Hash digest
SHA256 34d8d6358f5e30fc279c711dbce453ee100cbe0c89e8cd26e0a926d86e0e97ac
MD5 7d2bad8d9750ac24a723345acc110d39
BLAKE2b-256 b52a0ed1873981114c50398e5181de906023fb1a7156409766f186daff782c21

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