Installation

Requirements

• Python 3.10 or later

• Sphinx 5.0 or later

• icalendar 7.0 or later

• recurring-ical-events

From PyPI

The package is available on PyPI:

pip install sphinx-icalendar

From source

Clone the repository and install in editable mode:

git clone https://github.com/nicco/sphinx-icalendar-extension.git
cd sphinx-icalendar-extension
pip install -e .

Enabling the extension

Add sphinx_icalendar to the extensions list in your project’s conf.py:

extensions = [
    "sphinx_icalendar",
]

No further configuration is required.