Merge pull request #46 from Kraymer/rtfd

Add docs to be hosted by rtfd

.gitignore

@@ -4,3 +4,4 @@ dist/
 *.pyc
 .tox
 .coverage
+docs/_build

README.rst

@@ -1,14 +1,17 @@
 .. image:: https://travis-ci.org/Kraymer/qifqif.svg?branch=master
-    :target: https://travis-ci.org/Kraymer/qifqif
+  :target: https://travis-ci.org/Kraymer/qifqif
 .. image:: https://coveralls.io/repos/Kraymer/qifqif/badge.svg
-    :target: https://coveralls.io/r/Kraymer/qifqif
+  :target: https://coveralls.io/r/Kraymer/qifqif
 .. image:: http://img.shields.io/pypi/v/qifqif.svg
-    :target: https://pypi.python.org/pypi/qifqif  
+    :target: https://pypi.python.org/pypi/qifqif
+.. image:: https://readthedocs.org/projects/qifqif/badge/?version=latest
+:target: http://qifqif.readthedocs.org/en/latest/?badge=latest
+:alt: Documentation Status
 
 qifqif
 ======
 
-    /kĭf kĭf/ 
+    /kĭf kĭf/
      1. *adj. inv.* arabic slang (كيف) for "it's all the same".
      2. *n.* CLI tool for *categorizing* qif files. It can make all the difference.
 
@@ -40,8 +43,8 @@ Features
   completion
 - **Auditing mode:** review your transactions one by one
 - **Batch mode (no interactive):** for easy integration with scripts
-- **Easy-going workflow:** dreading the behemoth task of importing years of 
-  accounting from a single file? Don't be. Go at your own pace and press 
+- **Easy-going workflow:** dreading the behemoth task of importing years of
+  accounting from a single file? Don't be. Go at your own pace and press
   ``<Ctrl+C>`` to exit anytime. On next run, editing will resume right where
   you left it.
 
@@ -50,13 +53,13 @@ Usage
 
 ::
 
-    usage: qifqif [-h] [-a] [-c CONFIG] [-d | -o DEST] [-b] [-v] QIF_FILE    
+    usage: qifqif [-h] [-a] [-c CONFIG] [-d | -o DEST] [-b] [-v] QIF_FILE
 
     Enrich your .QIF files with tags. See https://github.com/Kraymer/qifqif for
-    more infos.    
+    more infos.
 
     positional arguments:
-      QIF_FILE              .QIF file to process    
+      QIF_FILE              .QIF file to process
 
     optional arguments:
       -h, --help            show this help message and exit
@@ -70,9 +73,9 @@ Usage
       -b, --batch-mode      skip transactions that require user input
       -v, --version         display version information and exit
 
-More infos on the `wiki`_ page
+More infos on the `documentation`_ website.
 
-.. _wiki: https://github.com/Kraymer/qifqif/wiki
+.. _documentation: http://qifqif.rtfd.org
 
 
 Installation
@@ -82,7 +85,7 @@ qiqif is written for `Python 2.7`_ and is tested on Linux, Mac OS X and Windows.
 
 Install with `pip`_ via ``pip install qifqif`` command.
 
-If you're on Windows and don't have pip yet, follow 
+If you're on Windows and don't have pip yet, follow
 `this guide`_ to install it.
 
 .. _Python 2.7: ttps://www.python.org/downloads/

docs/Makefile

@@ -0,0 +1,183 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/qifqif.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/qifqif.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/qifqif"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/qifqif"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/_templates/sidebarfooter.html

@@ -0,0 +1 @@
+

docs/_templates/sidebarintro.html

@@ -0,0 +1,4 @@
+<p>
+  qifqif is a robust CLI tool that categorize your transactions using his
+  flawless memory.
+</p>

docs/changelog.rst

@@ -0,0 +1,6 @@
+Changelog
+=========
+
+Available on `Github Releases page`_.
+
+.. _Github Releases page: https://github.com/Kraymer/qifqif/releases

docs/cli.rst

@@ -0,0 +1,25 @@
+CLI usage
+=========
+
+::
+
+    qifqif.py [-h] [-a | -b] [-c CONFIG] [-d | -o DEST] [-v] QIF_FILE
+
+qifqif inserts a ``L your_category`` line for each transaction
+of given QIF_FILE based on your existing matching history stored in CONFIG.
+
+Optional flags:
+
+- ``-a, --audit``: turn it on if you want to inspect every processed transaction
+  and category that got applied. Mutually exclusive with ``--batch`` mode as it
+  pause the process after each transaction.
+- ``-b, --batch``: in this mode, transactions that validate a registered match
+  are assigned a category but others are left untouched (no interactive prompt)
+- ``-c, --config``: by default, available categories and their matchings are
+  saved in ``~/.qifqif.json``. You can choose too to have different config
+  files eg one per family member.
+- ``-d, --dry-run``: print the result of qifqif work on the standard output
+  only, leaving the qif file untouched. Mutually exclusive with ``--output``
+- ``-o DEST, --output``: by default input file is edited in-place. Use that
+  switch to write in another output file instead.
+- ``-v, --version``: display version information and exit