Skip to content
This repository was archived by the owner on Aug 11, 2020. It is now read-only.

Commit 9f1ccc6

Browse files
author
Rocky Meza
committed
Cleaned up documentation a bit.
I added some installation documentation and wrote a bit more on completion. Also, now there's a Makefile to make it easier to write documentation.
1 parent e842b64 commit 9f1ccc6

File tree

4 files changed

+30
-13
lines changed

4 files changed

+30
-13
lines changed

Makefile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
PORT?=8008
2+
3+
test:
4+
python setup.py test
5+
6+
docs:
7+
cd docs && $(MAKE) html
8+
9+
docs-server: docs
10+
(sleep 1 && sensible-browser "http://localhost:$(PORT)")
11+
cd docs/_build/html/ && python -m SimpleHTTPServer $(PORT)
12+
13+
.PHONY: test docs docs-server

docs/index.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,22 @@ It is inspired by `ifscheme`.
1111

1212
The library also comes with an executable that you can use to manage your WiFi connections.
1313

14-
Contents:
1514

16-
.. toctree::
17-
:maxdepth: 2
15+
Installation
16+
------------
17+
18+
Wifi is available for installation on PyPI::
1819

19-
wifi_command
20-
scanning
20+
$ pip install wifi
2121

22+
This will install the :doc:`the wifi command <wifi_command>`, a Python library for discovering and connecting to wifi networks, and a bash completion file for the wifi command.
2223

2324

24-
Indices and tables
25-
==================
25+
Documentation
26+
-------------
27+
28+
.. toctree::
29+
:maxdepth: 2
2630

27-
* :ref:`genindex`
28-
* :ref:`modindex`
29-
* :ref:`search`
31+
wifi_command
32+
scanning

docs/wifi_command.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,6 @@ Connects to the network corresponding to SCHEME. ::
5252
Completion
5353
^^^^^^^^^^
5454

55-
The wifi command also comes with bash completion.
56-
To use the completion, source the `bash_completion` file that comes with the distribution.
55+
The wifi command also comes packaged with completion for bash.
56+
If you want to write completion for your own shell, wifi provides an interface for extracting completion information.
57+
Please see the ``wifi-completion.bash`` and ``bin/wifi`` files for more information.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def read(fname):
2929
packages=['wifi'],
3030
scripts=['bin/wifi'],
3131
test_suite='tests',
32-
platforms="Debian",
32+
platforms=["Debian"],
3333
license='BSD',
3434
install_requires=install_requires,
3535
classifiers=[

0 commit comments

Comments
 (0)