Faster indicomb with mkdocs markdown support
Project description
Faster indicomb with mkdocs markdown support. An alternative to the original indicomb.
This is fast enough to run in the CI as your docs get built (say goodby to your cron jobs!), and comes with mkdocs markdown support.
Quick Start
pip install indicomb2
Set up a config, see the example
Run:
indicomb2 -c my_config.yaml
You can configure indicomb2
to do a couple of things:
- The
scrape
section grabs events from an indico category and dumps them to json. You events in within the category. - The
meeting_summaries
section creates a dedicated page listing all the selected meetings in the category. For an example see here - The
minutes_summary
section creates a dedicated page listing all the minutes for seleccted meetings in the category. For an example see here - The
topical_contributions
appends a table to an existing page with contributions matching the given criteria. For an example see here
More details
- Set up a CERN docs site: https://how-to.docs.cern.ch/
- Add an environment variable
INDICO_API_TOKEN
with the token from https://indico.cern.ch/user/tokens/ - Setup a config, see the example
- Run
indicomb2 -c my_config.yaml
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
indicomb2-0.2.tar.gz
(7.5 kB
view details)
Built Distribution
File details
Details for the file indicomb2-0.2.tar.gz
.
File metadata
- Download URL: indicomb2-0.2.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a07cc891e0a8bd3f75b9c069c35d30143dbc9e82d16ae29923ab27e88a4a4d80 |
|
MD5 | 0e9c38391c1566314b565c2c8797380d |
|
BLAKE2b-256 | 3dec5a53d639b39f0c314a73523f47b8e0286bb291ae2cf22a55a3dd08201e83 |
File details
Details for the file indicomb2-0.2-py3-none-any.whl
.
File metadata
- Download URL: indicomb2-0.2-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d5dc2b70114b5296c29511248bf4aa976d23b6ac69cd2729cc1f49d39a5e1f0 |
|
MD5 | c9dfbc3478d3dff3975d27ef7ca85131 |
|
BLAKE2b-256 | 12ed499132200c9d4693eacda592300ca8f1f6f32e0b8465fe2192236086290b |