[Beginner] Correct broken links to classes & functions in documentation #1158
Description
Choose a documentation file and correct all the links to Python objects.
We have a lot of documentation files. Sometimes, we link to components, functions, and other objects and the links don't work.
- Working link:
- Broken link:
Please read through as many files as you like and do the following:
- If the file has no broken links, comment below that it is perfect! Thanks!
- If the file contains one or more broken links, please fix them (see guidance). They need the "fully qualified name". Example:
- If the file contains a prefix of
:pyon to the Python object, remove it. - Verify that the links that you fix are actually fixed by viewing the pull request preview that Read the Docs will generate after about one or two minutes. The link should appear in the pull request description automatically. If not, then visit https://app.readthedocs.org/projects/icalendar/builds/ to find your pull request's preview build, click it, and click the link to preview the docs. Also edit your PR description to include the link if it doesn't appear. This makes your PR easier to review.
Guidance
(GitHub only) For some files, you can Make small edits via GitHub.
(Local setup) For the API Reference in /reference/, you need to find the file in src/icalendar and build the documentation on your computer. See also #1072 for important details of how to hyperlink Python objects in docstrings.
Have a look at the different styles of links in the documentation.
Additionally, we value changes to the documentation to make it easier to understand for first-time users!
Checklist
All of these files need checking before closing the issue. If you create your first pull request, please only modify one file!
- 404.html
- about.html
- api.html
- changelog.html
- cli.html
- contribute/code-of-conduct.html
- contribute/credits.html
- contribute/development.html
- contribute/documentation/build-check.html
- contribute/documentation/index.html
- contribute/documentation/small-edits.html
- contribute/documentation/style-guide.html
- contribute/index.html
- contribute/maintenance.html
- contributing.html
- credits.html
- genindex.html
- how-to/attendees.html
- how-to/cli.html
- how-to/custom-components.html
- how-to/fuzz-testing.html
- how-to/index.html
- how-to/install.html
- how-to/jcal.html
- how-to/parse-errors.html
- how-to/QA.html
- how-to/upgrade.html
- how-to/usage.html
- index.html
- install.html
- license.html
- maintenance.html
- reference/api/icalendar.alarms.html
- reference/api/icalendar.attr.html
- reference/api/icalendar.cal.alarm.html
- reference/api/icalendar.cal.availability.html
- reference/api/icalendar.cal.available.html
- reference/api/icalendar.cal.calendar.html
- reference/api/icalendar.cal.component_factory.html
- reference/api/icalendar.cal.component.html
- reference/api/icalendar.cal.event.html
- reference/api/icalendar.cal.examples.html
- reference/api/icalendar.cal.free_busy.html
- reference/api/icalendar.cal.html
- reference/api/icalendar.cal.journal.html
- reference/api/icalendar.cal.timezone.html
- reference/api/icalendar.cal.todo.html
- reference/api/icalendar.caselessdict.html
- reference/api/icalendar.cli.html
- reference/api/icalendar.compatibility.html
- reference/api/icalendar.enums.html
- reference/api/icalendar.error.html
- reference/api/icalendar.html
- reference/api/icalendar.param.html
- reference/api/icalendar.parser_tools.html
- reference/api/icalendar.prop.xml_reference.html
- reference/api/icalendar.timezone.equivalent_timezone_ids.html
- reference/api/icalendar.timezone.html
- reference/api/icalendar.timezone.provider.html
- reference/api/icalendar.timezone.pytz.html
- reference/api/icalendar.timezone.tzid.html
- reference/api/icalendar.timezone.tzp.html
- reference/api/icalendar.timezone.windows_to_olson.html
- reference/api/icalendar.timezone.zoneinfo.html
- reference/api/icalendar.tools.html
- reference/api/icalendar.version.html
- reference/changelog.html
- reference/component-api.html
- reference/design.html
- reference/glossary.html
- reference/index.html
- search.html
- security.html
- usage.html
- reference/api/icalendar.parser.content_line.html
After #1150 is merged:
- reference/api/icalendar.parser.html
- reference/api/icalendar.parser.parameter.html
- reference/api/icalendar.parser.property.html
- reference/api/icalendar.parser.string.html
- reference/api/icalendar.parser_tools.html
After #1136 is merged:
- reference/api/icalendar.prop.adr.html
- reference/api/icalendar.prop.binary.html
- reference/api/icalendar.prop.boolean.html
- reference/api/icalendar.prop.broken.html
- reference/api/icalendar.prop.cal_address.html
- reference/api/icalendar.prop.categories.html
- reference/api/icalendar.prop.conference.html
- reference/api/icalendar.prop.dt.base.html
- reference/api/icalendar.prop.dt.common.html
- reference/api/icalendar.prop.dt.date.html
- reference/api/icalendar.prop.dt.datetime.html
- reference/api/icalendar.prop.dt.duration.html
- reference/api/icalendar.prop.dt.html
- reference/api/icalendar.prop.dt.list.html
- reference/api/icalendar.prop.dt.period.html
- reference/api/icalendar.prop.dt.time.html
- reference/api/icalendar.prop.dt.types.html
- reference/api/icalendar.prop.dt.utc_offset.html
- reference/api/icalendar.prop.factory.html
- reference/api/icalendar.prop.float.html
- reference/api/icalendar.prop.geo.html
- reference/api/icalendar.prop.html
- reference/api/icalendar.prop.image.html
- reference/api/icalendar.prop.inline.html
- reference/api/icalendar.prop.integer.html
- reference/api/icalendar.prop.n.html
- reference/api/icalendar.prop.org.html
- reference/api/icalendar.prop.recur.frequency.html
- reference/api/icalendar.prop.recur.html
- reference/api/icalendar.prop.recur.month.html
- reference/api/icalendar.prop.recur.recur.html
- reference/api/icalendar.prop.recur.skip.html
- reference/api/icalendar.prop.recur.weekday.html
- reference/api/icalendar.prop.text.html
- reference/api/icalendar.prop.uid.html
- reference/api/icalendar.prop.unknown.html
- reference/api/icalendar.prop.uri.html