diff options
author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-01-26 12:57:57 -0500 |
---|---|---|
committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-01-26 12:57:57 -0500 |
commit | 8e33bed3f57c7667e132148af76fe646d837e232 (patch) | |
tree | acab882c27707818b644d1d5c778436d9131c2c0 /docs | |
parent | 91ab799f293f0789bbb2759aaabc13c00da36b03 (diff) | |
download | cmd2-git-8e33bed3f57c7667e132148af76fe646d837e232.tar.gz |
Fixed broken links in Sphinx docs
Also:
- Added a "linkcheck" task to the invoke tasks
_ Use pseudoterminals for invoke tasks with colored output so that we can see the color when using invoke
Diffstat (limited to 'docs')
-rw-r--r-- | docs/examples/first_app.rst | 4 | ||||
-rw-r--r-- | docs/features/completion.rst | 2 | ||||
-rw-r--r-- | docs/features/history.rst | 2 | ||||
-rw-r--r-- | docs/overview/alternatives.rst | 6 | ||||
-rw-r--r-- | docs/overview/installation.rst | 8 |
5 files changed, 11 insertions, 11 deletions
diff --git a/docs/examples/first_app.rst b/docs/examples/first_app.rst index ef8e97dc..19d573b4 100644 --- a/docs/examples/first_app.rst +++ b/docs/examples/first_app.rst @@ -284,14 +284,14 @@ Users can access command history using two methods: - the `readline <https://docs.python.org/3/library/readline.html>`_ library which provides a python interface to the `GNU readline library - <https://tiswww.case.edu/php/chet/readline/rltop.html>`_ + <https://en.wikipedia.org/wiki/GNU_Readline>`_ - the ``history`` command which is built-in to ``cmd2`` From the prompt in a ``cmd2``-based application, you can press ``Control-p`` to move to the previously entered command, and ``Control-n`` to move to the next command. You can also search through the command history using ``Control-r``. The `GNU Readline User Manual -<https://tiswww.case.edu/php/chet/readline/rluserman.html>`_ has all the +<http://man7.org/linux/man-pages/man3/readline.3.html>`_ has all the details, including all the available commands, and instructions for customizing the key bindings. diff --git a/docs/features/completion.rst b/docs/features/completion.rst index 718fb3ba..41bc3b34 100644 --- a/docs/features/completion.rst +++ b/docs/features/completion.rst @@ -60,7 +60,7 @@ displayed to help the user. .. _arg_decorators: https://github.com/python-cmd2/cmd2/blob/master/examples/arg_decorators.py .. _colors: https://github.com/python-cmd2/cmd2/blob/master/examples/colors.py -.. _tab_autocompletion: https://github.com/python-cmd2/cmd2/blob/master/examples/tab_autocompletion..py +.. _tab_autocompletion: https://github.com/python-cmd2/cmd2/blob/master/examples/tab_autocompletion.py CompletionItem For Providing Extra Context diff --git a/docs/features/history.rst b/docs/features/history.rst index c1806065..3c238c3c 100644 --- a/docs/features/history.rst +++ b/docs/features/history.rst @@ -29,7 +29,7 @@ You can also search through the command history using ``Control-r``. Eric Johnson hosts a nice `readline cheat sheet <http://readline.kablamo.org/emacs.html>`_, or you can dig into the `GNU Readline User Manual -<https://tiswww.case.edu/php/chet/readline/rluserman.html>`_ for all the +<http://man7.org/linux/man-pages/man3/readline.3.html>`_ for all the details, including instructions for customizing the key bindings. ``cmd2`` makes a third type of history access available with the ``history`` diff --git a/docs/overview/alternatives.rst b/docs/overview/alternatives.rst index 63977334..27b356bc 100644 --- a/docs/overview/alternatives.rst +++ b/docs/overview/alternatives.rst @@ -10,8 +10,8 @@ argparse_. .. _sys: https://docs.python.org/3/library/sys.html .. _argparse: https://docs.python.org/3/library/argparse.html -.. _docopt: https://pypi.python.org/pypi/docopt -.. _click: http://click.pocoo.org +.. _docopt: https://pypi.org/project/docopt +.. _click: https://click.palletsprojects.com The curses_ module produces applications that interact via a plaintext terminal @@ -31,7 +31,7 @@ nonetheless. Two of the most mature and full featured are: * `Python Prompt Toolkit`_ * Click_ -.. _`Python Prompt Toolkit`: https://github.com/jonathanslenders/python-prompt-toolkit +.. _`Python Prompt Toolkit`: https://github.com/prompt-toolkit/python-prompt-toolkit `Python Prompt Toolkit`_ is a library for building powerful interactive command lines and terminal applications in Python. It provides a lot of advanced diff --git a/docs/overview/installation.rst b/docs/overview/installation.rst index 2bbe52a2..d8d24ebd 100644 --- a/docs/overview/installation.rst +++ b/docs/overview/installation.rst @@ -3,9 +3,9 @@ Installation Instructions ========================= -.. _pip: https://pypi.python.org/pypi/pip -.. _setuptools: https://pypi.python.org/pypi/setuptools -.. _PyPI: https://pypi.python.org/pypi +.. _pip: https://pypi.org/project/pip +.. _setuptools: https://pypi.org/project/setuptools +.. _PyPI: https://pypi.org ``cmd2`` works on Linux, macOS, and Windows. It requires Python 3.5 or higher, pip_, and setuptools_. If you've got all that, then you can just: @@ -129,7 +129,7 @@ environment on a Mac, detailed in the following subsections. gnureadline Python module ~~~~~~~~~~~~~~~~~~~~~~~~~ -Install the `gnureadline <https://pypi.python.org/pypi/gnureadline>`_ Python module which is statically linked against a specific compatible version of GNU Readline: +Install the `gnureadline <https://pypi.org/project/gnureadline>`_ Python module which is statically linked against a specific compatible version of GNU Readline: .. code-block:: shell |