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

Uploaded Source

Built Distribution

indicomb2-0.4-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: indicomb2-0.4.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for indicomb2-0.4.tar.gz
Algorithm Hash digest
SHA256 86fad5056c3b8d578937697ebf38211eb189c18274ed4b6405de31d6ab8253b1
MD5 a202f80e44053fe049058f161060dccd
BLAKE2b-256 f43b33d7ee7d99733d8746008b1ed70b8939d87068f6de9e217b34684ecc8e3c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: indicomb2-0.4-py3-none-any.whl
  • Upload date:
  • Size: 9.8 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 73b165120cd2eda2aea8f2c835c5263477c60ff320022b02c6f687958975af1e
MD5 7a8ab2f898fff0a304fe5ef74dd4cd63
BLAKE2b-256 413d50833ed6a250d039e72405db264546c75eb7905e8586281a71928f5e41ba

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