Skip to content

docs: fix broken links in tutorials/create-event-with-attendees.rst#1455

Open
sangamithraashok244-ship-it wants to merge 1 commit into
collective:mainfrom
sangamithraashok244-ship-it:patch-1
Open

docs: fix broken links in tutorials/create-event-with-attendees.rst#1455
sangamithraashok244-ship-it wants to merge 1 commit into
collective:mainfrom
sangamithraashok244-ship-it:patch-1

Conversation

@sangamithraashok244-ship-it

@sangamithraashok244-ship-it sangamithraashok244-ship-it commented Jun 13, 2026

Copy link
Copy Markdown

Fixes broken links in the tutorials file as part of issue #1158.
Removed the ~ prefix from :class: and :meth: references to make links fully qualified.


📚 Documentation preview 📚: https://icalendar--1455.org.readthedocs.build/en/1455/

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 icalendar | 🛠️ Build #33125405 | 📁 Comparing 309fe85 against latest (acc0a15)

  🔍 Preview build  

2 files changed
± 404.html
± tutorials/create-event-with-attendees.html

@stevepiercy

Copy link
Copy Markdown
Member

@sangamithraashok244-ship-it thank you for your contribution.

I wonder whether you tried the links before changing them? The links appear to work as is, and the ~ changes the rendering of the links to the last segment of the Python object's dotted path. This is often desirable. See https://www.sphinx-doc.org/en/master/usage/domains/python.html#target-specification.

You can build the documentation locally to test. See https://icalendar.readthedocs.io/en/stable/contribute/documentation/build-check.html.

Also please see our Contribute guide for pull request requirements.

Please let me know. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants