Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
Project description
Documenteer
Documenteer provides tools, extensions, and configurations for Rubin Observatory's Sphinx documentation projects, including 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 technical note projects:
pip install "documenteer[technote]"
For the stack projects (such as the LSST Science Pipelines):
pip install "documenteer[pipelines]"
Features
Configurations
Documenteer includes preset configurations for common Rubin Observatory Sphinx projects. By using Documenteer, you can also ensure that Sphinx extensions required by these configurations are installed.
From the conf.py for technotes:
from documenteer.conf.technote import *
From the conf.py for a stack package:
from documenteer.conf.pipelinespkg import *
project = "example"
html_theme_options['logotext'] = project
html_title = project
html_short_title = project
From the conf.py for the LSST Science Pipelines documentation:
from documenteer.conf.pipelines import *
Command-line tools
- package-docs builds documentation for individual packages in the LSST Science Pipelines
- stack-docs builds documentation for entire Stacks, such as the LSST Science Pipelines
- refresh-lsst-bib maintains Rubin Observatory's common BibTeX files in individual technote repositories
Sphinx extensions
- Roles for linking to LSST documents and Jira tickets
- The
remote-code-blockdirective - The
module-toctreeandpackage-toctreedirectives for the LSST Science Pipelines documentation - Extensions for documenting LSST Science Pipelines tasks
- Support for LSST BibTeX files with sphinxcontrib-bibtex.
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
Built Distribution
File details
Details for the file documenteer-0.7.0b1.tar.gz.
File metadata
- Download URL: documenteer-0.7.0b1.tar.gz
- Upload date:
- Size: 623.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 257ba3e2c716eff3cef9423c9e7f59497cb56cec0a68ee2f1cbf67ae6414b271 |
|
| MD5 | d3b504a58c42408af33383937d979aa0 |
|
| BLAKE2b-256 | e6ea598ddaf76b8a5957558daede6c3816d1f80b9b98e81d95e30eb243e2c68b |
File details
Details for the file documenteer-0.7.0b1-py3-none-any.whl.
File metadata
- Download URL: documenteer-0.7.0b1-py3-none-any.whl
- Upload date:
- Size: 184.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c3459cc7d0a0afc552cfebef99eff68e28cc23fc837e09c233b5a2a3a5653b87 |
|
| MD5 | 26e7f4cc5ce56bac6ed9d9b91b2b40a9 |
|
| BLAKE2b-256 | 5f2b106b2e2d59612b47de92e3662b64cbb8fe3c3c13902350aa91eb2b62f38b |
