diff --git a/docs/conf.py b/docs/conf.py index 7ba264f..60ab628 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,6 +44,10 @@ 'myst_parser' ] +# MyST does not generate heading anchors unless asked, so a link to another page's +# section, such as value_scaling_and_auto_sizing.md#value-scaling, silently fails. +myst_heading_anchors = 3 + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -61,7 +65,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/examples/plot_with_characters_or_icons.md b/docs/examples/plot_with_characters_or_icons.md index e42a769..6de12d0 100644 --- a/docs/examples/plot_with_characters_or_icons.md +++ b/docs/examples/plot_with_characters_or_icons.md @@ -40,7 +40,7 @@ See [issue #17](https://github.com/gyli/PyWaffle/issues/17) for the original rep Waffle Chart with icons is also known as Pictogram Chart. PyWaffle supports plotting with icons through [Font Awesome](https://fontawesome.com/), which is an -optional dependency — install it with `pip install "pywaffle[icons]"`. See page [Font Awesome Integration](font_awesome_integration.html) for how Font Awesome is integrated into PyWaffle. +optional dependency — install it with `pip install "pywaffle[icons]"`. See page [Font Awesome Integration](../font_awesome_integration.rst) for how Font Awesome is integrated into PyWaffle. For searching available icon name in Font Awesome, please visit [https://fontawesome.com/search](https://fontawesome.com/search). diff --git a/pywaffle/waffle.py b/pywaffle/waffle.py index 83ce12b..264418f 100644 --- a/pywaffle/waffle.py +++ b/pywaffle/waffle.py @@ -170,12 +170,11 @@ class Waffle(Figure): :param icon_style: The style of icons to be used. | Font Awesome Icons find an icon by style and icon name. - The style could be 'brands', 'regular' and 'solid'. - Visit https://fontawesome.com/cheatsheet for detail. - + The style could be 'brands', 'regular' and 'solid'. + Visit https://fontawesome.com/cheatsheet for detail. | If it is a string, it would search icons within given style. - If it is a list or a tuple, the length should be - the same as values and it means the style for each icon. + If it is a list or a tuple, the length should be + the same as values and it means the style for each icon. | [Default 'solid'] :type icon_style: str|list[str]|tuple[str], optional @@ -817,7 +816,7 @@ def _validate_icon_style(self, par: Dict): @classmethod def make_waffle(cls, ax: Axes, **kwargs): - """ + r""" Plot waffle chart on given axis. Run it with codes like: ``Waffle.make_waffle(ax=ax, rows=5, values=[48, 46, 6])`` @@ -828,7 +827,7 @@ def make_waffle(cls, ax: Axes, **kwargs): :param ax: An instance of Matplotlib Axes :type ax: matplotlib.axes.Axes - :param **kwargs: Waffle properties + :param \*\*kwargs: Waffle properties """ if kwargs.get("plots"):