- Notifications
You must be signed in to change notification settings - Fork0
lsst-sqre/sqr-040
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This technote describes the EFD Aggregator, a Kafka aggregator based on the Faust Python Stream Processing library.
Links:
- Publication URL:https://sqr-040.lsst.io
- Alternative editions:https://sqr-040.lsst.io/v
- GitHub repository:https://github.com/lsst-sqre/sqr-040
- Build system:https://travis-ci.com/lsst-sqre/sqr-040
You can clone this repository and build the technote locally withSphinx:
git clone https://github.com/lsst-sqre/sqr-040cd sqr-040pip install -r requirements.txtmake htmlNote
In aConda environment,pip install -r requirements.txt doesn't work as expected.Instead,pip install the packages listed inrequirements.txt individually.
The built technote is located at_build/html/index.html.
You can edit theindex.rst file, which is a reStructuredText document.TheDM reStructuredText Style Guide is a good resource for how we write reStructuredText.
Remember that images and other types of assets should be stored in the_static/ directory of this repository.See_static/README.rst for more information.
The published technote athttps://sqr-040.lsst.io will be automatically rebuilt whenever you push your changes to themaster branch onGitHub.
This technote's metadata is maintained inmetadata.yaml.In this metadata you can edit the technote's title, authors, publication date, etc..metadata.yaml is self-documenting with inline comments.
The bibliography files inlsstbib/ are copies fromlsst-texmf.You can update them to the currentlsst-texmf versions with:
make refresh-bib
Add new bibliography items to thelocal.bib file in the root directory (and later add them tolsst-texmf).