diff options
| author | Seth Morton <seth.m.morton@gmail.com> | 2018-11-10 10:14:21 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-10 10:14:21 -0800 |
| commit | 1e4ba38b99eeca5d23ad32de58f19e683bc3be8a (patch) | |
| tree | 2d2b4afa668c627192a19ff8a1df17e1c9999946 | |
| parent | f7cffcc5c5e1c876387c6aad7a8ed6d5bca9e822 (diff) | |
| parent | f48dd766f45d550a1a8a43d367c324904b9f2b65 (diff) | |
| download | natsort-1e4ba38b99eeca5d23ad32de58f19e683bc3be8a.tar.gz | |
Merge pull request #75 from jdufresne/doc-links
Use native Sphinx ref linking to create automatic links in docs
| -rw-r--r-- | docs/source/intro.rst | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/source/intro.rst b/docs/source/intro.rst index b53f8ac..52d31f8 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -258,9 +258,8 @@ How do I debug :func:`~natsorted`? with the same options being passed to :func:`~natsorted`. One can take a look at exactly what is being done with their input using this key - it is highly recommended to `look at this issue describing how to debug <https://github.com/SethMMorton/natsort/issues/13#issuecomment-50422375>`_ - for *how* to debug, and also to review the - `How Does Natsort Work? <https://natsort.readthedocs.io/en/master/howitworks.html>`_ - page for *why* :mod:`natsort` is doing that to your data. + for *how* to debug, and also to review the :ref:`howitworks` page for *why* + :mod:`natsort` is doing that to your data. If you are trying to sort custom classes and running into trouble, please take a look at https://github.com/SethMMorton/natsort/issues/60. In short, @@ -270,8 +269,7 @@ How do I debug :func:`~natsorted`? use the :mod:`natsort` key as part of your rich comparison operator definition. How *does* :mod:`natsort` work? - If you don't want to read `How Does Natsort Work? <https://natsort.readthedocs.io/en/master/howitworks.html>`_, - here is a quick primer. + If you don't want to read :ref:`howitworks`, here is a quick primer. :mod:`natsort` provides a `key function <https://docs.python.org/3/howto/sorting.html#key-functions>`_ that can be passed to `list.sort() <https://docs.python.org/3/library/stdtypes.html#list.sort>`_ @@ -341,8 +339,8 @@ PyICU +++++ It is recommended that you install `PyICU <https://pypi.org/project/PyICU>`_ -if you wish to sort in a locale-dependent manner, see -https://natsort.readthedocs.io/en/master/locale_issues.html for an explanation why. +if you wish to sort in a locale-dependent manner, see :ref:`locale_issues` for +an explanation why. Installation ------------ |