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[guides]"

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-0.8.4.tar.gz (632.2 kB view details)

Uploaded Source

Built Distribution

documenteer-0.8.4-py3-none-any.whl (186.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-0.8.4.tar.gz
  • Upload date:
  • Size: 632.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for documenteer-0.8.4.tar.gz
Algorithm Hash digest
SHA256 c92a0766766bcdcbbbd3b06fbb251b5c2dbad41f81be37677cc61fbd58604594
MD5 715c5f9c766fa21090b738aeab88ae84
BLAKE2b-256 058aa189b7215ed380c447b770492c9a2619bfe240bdc24a433efa505183aee2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-0.8.4-py3-none-any.whl
  • Upload date:
  • Size: 186.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for documenteer-0.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f54553006cc2416613163644a93b20c7f1934e9026de08d52a7e35055cb37e19
MD5 e8f3e586129fae8265edb61b2c1e9d93
BLAKE2b-256 cbed4c83a076190bf6ae2b8161460fbee9cc66b3f29970fd3e6c31bee0676468

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