Add docs.

Author: kylepw

Pipfile

@@ -9,6 +9,7 @@ wheel = "*"
 flake8 = "*"
 tox = "*"
 coverage = "*"
+sphinx = "*"
 
 [packages]
 tqdm = "*"

Pipfile.lock

@@ -3,12 +3,15 @@ wikiwall
 ========
 .. image:: https://travis-ci.com/kylepw/wikiwall.svg?branch=master
     :target: https://travis-ci.com/kylepw/wikiwall
+.. image:: https://readthedocs.org/projects/wikiwall/badge/?version=latest
+	:target: https://wikiwall.readthedocs.io/en/latest/?badge=latest
+	:alt: Documentation Status
 .. image:: https://coveralls.io/repos/github/kylepw/wikiwall/badge.svg?branch=master
 	:target: https://coveralls.io/github/kylepw/wikiwall?branch=master
 
 *wikiwall* is a CLI that downloads a random image from Wikiart's Hi-Res page and sets it as your desktop background in macOS.
 
-.. image:: https://github.com/kylepw/wikiwall/blob/master/example.gif
+.. image:: https://github.com/kylepw/wikiwall/blob/master/docs/_static/example.gif
 	:align: center
 
 Features
@@ -21,7 +24,6 @@ Requirements
 - Python 3.6 or higher
 - macOS
 
-
 Installation
 ------------
 ::
@@ -30,12 +32,11 @@ Installation
 
 If you want, set your wallpaper to change every night with launchd: ::
 
-	$ git clone https://github.com/kylepw/wikiwall.git
-	$ sed -i.bak -e "s|WIKIWALL|$(which wikiwall)|g" wikiwall/wikiwall.plist
-	$ cp wikiwall/wikiwall.plist ~/Library/LaunchAgents
+	$ git clone https://github.com/kylepw/wikiwall.git && cd wikiwall
+	$ sed -i.bak -e "s|WIKIWALL|$(which wikiwall)|g" wikiwall.plist
+	$ cp wikiwall.plist ~/Library/LaunchAgents
 	$ launchctl load ~/Library/LaunchAgents/wikiwall.plist
 
-
 Usage
 -----
 ::
@@ -57,8 +58,7 @@ Usage
 
 Todo
 ----
-- Add documentation to Sphinx.
-- Add support for other operating systems.
+- Set wallpaper on a desktop not currently being viewed.
 - Provide preview of image before setting as background.
 
 License

README.rst

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/Makefile

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 30f6649263ddfebcbb85cdb5e2e7d644
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/doctrees/environment.pickle

@@ -0,0 +1,68 @@
+========
+wikiwall
+========
+.. image:: https://travis-ci.com/kylepw/wikiwall.svg?branch=master
+    :target: https://travis-ci.com/kylepw/wikiwall
+.. image:: https://readthedocs.org/projects/wikiwall/badge/?version=latest
+	:target: https://wikiwall.readthedocs.io/en/latest/?badge=latest
+	:alt: Documentation Status
+.. image:: https://coveralls.io/repos/github/kylepw/wikiwall/badge.svg?branch=master
+	:target: https://coveralls.io/github/kylepw/wikiwall?branch=master
+
+*wikiwall* is a CLI that downloads a random image from Wikiart's Hi-Res page and sets it as your desktop background in macOS.
+
+.. image:: /_static/example.gif
+
+Features
+--------
+- Easily customize your desktop with new hi-res artwork from the command line.
+- Update your wallpaper periodically with your favorite scheduler.
+
+Requirements
+------------
+- Python 3.6 or higher
+- macOS
+
+Installation
+------------
+::
+
+	$ pip3 install wikiwall
+
+If you want, set your wallpaper to change every night with launchd: ::
+
+	$ git clone https://github.com/kylepw/wikiwall.git && cd wikiwall
+	$ sed -i.bak -e "s|WIKIWALL|$(which wikiwall)|g" wikiwall.plist
+	$ cp wikiwall.plist ~/Library/LaunchAgents
+	$ launchctl load ~/Library/LaunchAgents/wikiwall.plist
+
+Usage
+-----
+::
+
+	$ wikiwall --help
+	Usage: wikiwall [OPTIONS] COMMAND [ARGS]...
+
+  	  Set desktop background in macOS to random WikiArt image.
+
+	Options:
+  	  --dest TEXT      Download images to specified destination.
+  	  --limit INTEGER  Number of files to keep in download directory. Set to -1
+   	                   for no limit. Default is 10.
+  	  --debug          Show debugging messages.
+  	  --help           Show this message and exit.
+
+	Commands:
+  	  show  Show previous downloads in Finder.
+
+Todo
+----
+- Set wallpaper on a desktop not currently being viewed.
+- Provide preview of image before setting as background.
+
+License
+-------
+`MIT License <https://github.com/kylepw/wikiwall/blob/master/LICENSE>`_
+
+.. toctree::
+   :maxdepth: 1