diff options
author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-07-18 22:24:27 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-07-18 22:24:27 -0400 |
commit | 128d94accb0a6a8ab7197d26dab2cdafd83a1922 (patch) | |
tree | 2ab29574a1db3c4e709e1e4542113de43f84128d | |
parent | de6d4933af4201ac6a8c4f7a2b9802dd7ed52cc2 (diff) | |
parent | 11a1ad03da630da28d39f1fb4a573f855cc7a661 (diff) | |
download | cmd2-git-128d94accb0a6a8ab7197d26dab2cdafd83a1922.tar.gz |
Merge pull request #732 from python-cmd2/reorder_docs
Fix broken documentation links
-rw-r--r-- | CHANGELOG.md | 2 | ||||
-rw-r--r-- | CONTRIBUTING.md | 2 | ||||
-rwxr-xr-x | README.md | 12 | ||||
-rw-r--r-- | docs/index.rst | 12 |
4 files changed, 15 insertions, 13 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index e17aef6b..1dc202aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -55,7 +55,7 @@ * `pexcept` - print Exception message to sys.stderr. If debug is true, print exception traceback if one exists * Signature of `poutput` and `perror` significantly changed * Removed color parameters `color`, `err_color`, and `war_color` from `poutput` and `perror` - * See the docstrings of these methods or the [cmd2 docs](https://cmd2.readthedocs.io/en/latest/unfreefeatures.html#poutput-pfeedback-perror-ppaged) for more info on applying styles to output messages + * See the docstrings of these methods or the [cmd2 docs](https://cmd2.readthedocs.io/en/latest/features/generating_output.html) for more info on applying styles to output messages * `end` argument is now keyword-only and cannot be specified positionally * `traceback_war` no longer exists as an argument since it isn't needed now that `perror` and `pexcept` exist * Moved `cmd2.Cmd.colors` to ansi.py and renamed it to `allow_ansi`. This is now an application-wide setting. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5217b4b..e0ae7625 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -290,7 +290,7 @@ $ python examples/example.py ``` You can type `help` to get help or `quit` to quit. If you see that, then congratulations -– you're all set. Otherwise, refer to the cmd2 [installation instructions](https://cmd2.readthedocs.io/en/latest/install.html#installing). +– you're all set. Otherwise, refer to the cmd2 [installation instructions](https://cmd2.readthedocs.io/en/latest/overview/installation.html). There also might be an error in the console of your Bash / terminal / command line that will help identify the problem. @@ -64,7 +64,7 @@ pip install -U cmd2 cmd2 works with Python 3.5+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party dependencies. For information on other installation options, see -[Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2 +[Installation Instructions](https://cmd2.readthedocs.io/en/latest/overview/installation.html) in the cmd2 documentation. @@ -108,8 +108,8 @@ Instructions for implementing each feature follow. - If you wish to exclude some of your custom commands from the history, append their names to the list at `Cmd.exclude_from_history`. - Do `help history` in any `cmd2` application for more information -- Simple scripting using ASCII text files with one command + arguments per line - - See the [Script files](https://cmd2.readthedocs.io/en/latest/freefeatures.html#script-files) section of the `cmd2` docs for more info +- Simple scripting using text files with one command + arguments per line + - See the [Command Scripts](https://cmd2.readthedocs.io/en/latest/features/scripting.html#command-scripts) section of the `cmd2` docs for more info - See [script.txt](https://github.com/python-cmd2/cmd2/blob/master/examples/scripts/script.txt) for a trivial example script that can be used in any `cmd2` application with the `run_script` command (or `@` shortcut) @@ -117,7 +117,7 @@ Instructions for implementing each feature follow. - Run arbitrary Python scripts within your `cmd2` application with the ability to also call custom `cmd2` commands - No separate API for your end users to learn - Syntax for calling `cmd2` commands in a `run_pyscript` is essentially identical to what they would enter on the command line - - See the [Python](https://cmd2.readthedocs.io/en/latest/freefeatures.html#python) section of the `cmd2` docs for more info + - See the [Python Scripts](https://cmd2.readthedocs.io/en/latest/features/scripting.html#python-scripts) section of the `cmd2` docs for more info - Also see the [python_scripting.py](https://github.com/python-cmd2/cmd2/blob/master/examples/python_scripting.py) example in conjunction with the [conditional.py](https://github.com/python-cmd2/cmd2/blob/master/examples/scripts/conditional.py) script @@ -148,7 +148,7 @@ Instructions for implementing each feature follow. self.stdout.write('{}\n'.format(' '.join(words))) ``` - See https://cmd2.readthedocs.io/en/latest/argument_processing.html for more details + See [Argument Processing](https://cmd2.readthedocs.io/en/latest/features/argument_processing.html) in the docs for more details NOTE: `cmd2` also provides the `Cmd2ArgumentParser` customization of `argparse.ArgumentParser` for prettier formatting of help and error messages. @@ -367,6 +367,8 @@ Here are a few examples of open-source projects which use `cmd2`: * Automatic analysis of SWF files based on some heuristics. Extensible via plugins. * [tomcatmanager](https://github.com/tomcatmanager/tomcatmanager) * A command line tool and python library for managing a tomcat server +* [Expliot](https://gitlab.com/expliot_framework/expliot) + * Internet of Things (IoT) exploitation framework * [mptcpanalyzer](https://github.com/teto/mptcpanalyzer) * Tool to help analyze mptcp pcaps * [clanvas](https://github.com/marklalor/clanvas) diff --git a/docs/index.rst b/docs/index.rst index c21cfeb1..14da2d20 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -58,22 +58,22 @@ Features features/index -API Reference -============= +Examples +======== .. toctree:: :maxdepth: 2 - api/index + examples/index -Examples -======== +API Reference +============= .. toctree:: :maxdepth: 2 - examples/index + api/index Meta |