Skip to content

Commit

Permalink
Fix documentation warning about relative links
Browse files Browse the repository at this point in the history
It seems that relative links to the generated `.html` files doesn't work
anymore, so I've replaced them with either `doc` or `mod` references.
  • Loading branch information
pganssle committed Aug 28, 2020
1 parent 43b7838 commit c35824e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions changelog.d/1078.misc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Change some relative links in the exercise documentation to refer to the document locations in the input tree, rather than the generated HTML files in the HTML output tree (which presumably will not exist in non-HTML output formats). GH PR #1078.
6 changes: 3 additions & 3 deletions docs/exercises/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Martin Luther King Day

`Martin Luther King, Jr Day <https://en.wikipedia.org/wiki/Martin_Luther_King_Jr._Day>`_ is a US holiday that occurs every year on the third Monday in January?

How would you generate a `recurrence rule <../rrule.html>`_ that generates Martin Luther King Day, starting from its first observance in 1986?
How would you generate a :doc:`recurrence rule <../rrule>` that generates Martin Luther King Day, starting from its first observance in 1986?


**Test Script**
Expand Down Expand Up @@ -74,7 +74,7 @@ A solution to this problem is provided :doc:`here <solutions/mlk-day-rrule>`.
Next Monday meeting
-------------------

A team has a meeting at 10 AM every Monday and wants a function that tells them, given a ``datetime.datetime`` object, what is the date and time of the *next* Monday meeting? This is probably best accomplished using a `relativedelta <../relativedelta.html>`_.
A team has a meeting at 10 AM every Monday and wants a function that tells them, given a ``datetime.datetime`` object, what is the date and time of the *next* Monday meeting? This is probably best accomplished using a :doc:`relativedelta <../relativedelta>`.

**Test Script**

Expand Down Expand Up @@ -125,7 +125,7 @@ To solve this exercise, copy-paste this script into a document, change anything
Parsing a local tzname
----------------------

Three-character time zone abbreviations are *not* unique in that they do not explicitly map to a time zone. A list of time zone abbreviations in use can be found `here <https://www.timeanddate.com/time/zones/>`_. This means that parsing a datetime string such as ``'2018-01-01 12:30:30 CST'`` is ambiguous without context. Using `dateutil.parser <../parser.html>`_ and `dateutil.tz <../tz.html>`_, it is possible to provide a context such that these local names are converted to proper time zones.
Three-character time zone abbreviations are *not* unique in that they do not explicitly map to a time zone. A list of time zone abbreviations in use can be found `here <https://www.timeanddate.com/time/zones/>`_. This means that parsing a datetime string such as ``'2018-01-01 12:30:30 CST'`` is ambiguous without context. Using :mod:`dateutil.parser` and :mod:`dateutil.tz`, it is possible to provide a context such that these local names are converted to proper time zones.

Problem 1
*********
Expand Down

0 comments on commit c35824e

Please sign in to comment.