Skip to content

Commit ded7396

Browse files
Merge pull request #1305 from claw-explorer/docs-fix-broken-links
docs: fix toctree and broken doc reference warnings
2 parents 8d9046d + 97b0787 commit ded7396

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

CHANGES.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Documentation
5151
- Add Repology badge and distribution installation instructions to install documentation. :issue:`1119`
5252
- Updated references to :class:`~icalendar.prop.uri.vUri` and :class:`~icalendar.enums.RELTYPE` classes in :file:`attr.py`. :issue:`1158`
5353
- Convert docstrings in ``attr.py`` and ``cal/calendar.py`` to Google Style format. :issue:`1072`
54-
- Explained import shortcuts in :doc:`component-api` documentation. :issue:`1161`
54+
- Explained import shortcuts in :doc:`../explanation/api-design` documentation. :issue:`1161`
5555
- Added tutorial for creating a calendar with events with attendees. :pr:`1262`
5656
- Added recognition of NLnet Foundation for its funding and Open Collective for donations to the documentation footer. :issue:`1214`
5757
- Documented ``vText`` properties according to :rfc:`5545#section-3.3.11`. :issue:`742`

docs/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,13 @@ icalendar lets you create, inspect, and modify calendaring information with Pyth
9090

9191
tutorials/index
9292

93+
.. toctree::
94+
:caption: Explanation
95+
:maxdepth: 2
96+
:hidden:
97+
98+
explanation/index
99+
93100
.. toctree::
94101
:caption: Reference
95102
:hidden:

0 commit comments

Comments
 (0)