Skip to main content

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:

  1. The scrape section grabs events from an indico category and dumps them to json. You events in within the category.
  2. The meeting_summaries section creates a dedicated page listing all the selected meetings in the category. For an example see here
  3. The minutes_summary section creates a dedicated page listing all the minutes for seleccted meetings in the category. For an example see here
  4. The topical_contributions appends a table to an existing page with contributions matching the given criteria. For an example see here

More details

  1. Set up a CERN docs site: https://how-to.docs.cern.ch/
  2. Add an environment variable INDICO_API_TOKEN with the token from https://indico.cern.ch/user/tokens/
  3. Setup a config, see the example
  4. 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.3.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

indicomb2-0.3-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file indicomb2-0.3.tar.gz.

File metadata

  • Download URL: indicomb2-0.3.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

Hashes for indicomb2-0.3.tar.gz
Algorithm Hash digest
SHA256 c1e8718b89d4736afdfb9d3978b629c887af375d9a47c961c5b869d91e3c0115
MD5 c7bbaef446d5575ef854e3903ae67ba8
BLAKE2b-256 8c3534f9703ea7d196f206089a5151a1aa997cb554213dac0f9cca7966c3a02a

See more details on using hashes here.

File details

Details for the file indicomb2-0.3-py3-none-any.whl.

File metadata

  • Download URL: indicomb2-0.3-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for indicomb2-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6b42082ce2865366247fcd6f35e224cf0095b92a137cc956edb62debbed0cd16
MD5 e91d09e043467818eb520263706d5858
BLAKE2b-256 7a189f2f0d8dd342fa9e9e103cb98ebc492be5177028323663bebad38b36870f

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