laneya

commit

a1646ccf6ff68f4f4d5720f7118e236dd6e82831

parent

090989371c74a485d91a8401b831aca454db76d2

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2018-08-03 10:56

rm docs

Diffstat

11 files changed, 0 insertions, 754 deletions

diff --git a/README.rst b/README.rst

@@ -23,21 +23,6 @@ laneya consists of two programs: A server called ``laneyad`` and a client
   23    23 called ``laneya``.
   24    24 
   25    25 
   26    -1 Build Documentation
   27    -1 -------------------
   28    -1 
   29    -1 An HTML documentation can be automatically generated from source code using
   30    -1 `sphinx`_::
   31    -1 
   32    -1   pip install sphinx
   33    -1   python setup.py build_sphinx
   34    -1   xdg-open docs/build/html/index.html
   35    -1 
   36    -1 To add a new module to the documentation, create a corresponding file in
   37    -1 ``docs/source/`` and add an entry to the table of contents in
   38    -1 ``docs/source/index.rst``.
   39    -1 
   40    -1 
   41    26 Run Tests
   42    27 ---------
   43    28 
@@ -55,6 +40,3 @@ Alternatively you can run the tests manually::
   55    40   flake8
   56    41   nosetests
   57    42   xdg-open .cover/index.html
   58    -1 
   59    -1 
   60    -1 .. _sphinx: http://sphinx-doc.org

diff --git a/docs/Makefile b/docs/Makefile

@@ -1,177 +0,0 @@
    1    -1 # Makefile for Sphinx documentation
    2    -1 #
    3    -1 
    4    -1 # You can set these variables from the command line.
    5    -1 SPHINXOPTS    =
    6    -1 SPHINXBUILD   = sphinx-build
    7    -1 PAPER         =
    8    -1 BUILDDIR      = build
    9    -1 
   10    -1 # User-friendly check for sphinx-build
   11    -1 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
   12    -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/)
   13    -1 endif
   14    -1 
   15    -1 # Internal variables.
   16    -1 PAPEROPT_a4     = -D latex_paper_size=a4
   17    -1 PAPEROPT_letter = -D latex_paper_size=letter
   18    -1 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
   19    -1 # the i18n builder cannot share the environment and doctrees with the others
   20    -1 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
   21    -1 
   22    -1 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
   23    -1 
   24    -1 help:
   25    -1 	@echo "Please use \`make <target>' where <target> is one of"
   26    -1 	@echo "  html       to make standalone HTML files"
   27    -1 	@echo "  dirhtml    to make HTML files named index.html in directories"
   28    -1 	@echo "  singlehtml to make a single large HTML file"
   29    -1 	@echo "  pickle     to make pickle files"
   30    -1 	@echo "  json       to make JSON files"
   31    -1 	@echo "  htmlhelp   to make HTML files and a HTML help project"
   32    -1 	@echo "  qthelp     to make HTML files and a qthelp project"
   33    -1 	@echo "  devhelp    to make HTML files and a Devhelp project"
   34    -1 	@echo "  epub       to make an epub"
   35    -1 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
   36    -1 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
   37    -1 	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
   38    -1 	@echo "  text       to make text files"
   39    -1 	@echo "  man        to make manual pages"
   40    -1 	@echo "  texinfo    to make Texinfo files"
   41    -1 	@echo "  info       to make Texinfo files and run them through makeinfo"
   42    -1 	@echo "  gettext    to make PO message catalogs"
   43    -1 	@echo "  changes    to make an overview of all changed/added/deprecated items"
   44    -1 	@echo "  xml        to make Docutils-native XML files"
   45    -1 	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
   46    -1 	@echo "  linkcheck  to check all external links for integrity"
   47    -1 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
   48    -1 
   49    -1 clean:
   50    -1 	rm -rf $(BUILDDIR)/*
   51    -1 
   52    -1 html:
   53    -1 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
   54    -1 	@echo
   55    -1 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
   56    -1 
   57    -1 dirhtml:
   58    -1 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
   59    -1 	@echo
   60    -1 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
   61    -1 
   62    -1 singlehtml:
   63    -1 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
   64    -1 	@echo
   65    -1 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
   66    -1 
   67    -1 pickle:
   68    -1 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
   69    -1 	@echo
   70    -1 	@echo "Build finished; now you can process the pickle files."
   71    -1 
   72    -1 json:
   73    -1 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
   74    -1 	@echo
   75    -1 	@echo "Build finished; now you can process the JSON files."
   76    -1 
   77    -1 htmlhelp:
   78    -1 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
   79    -1 	@echo
   80    -1 	@echo "Build finished; now you can run HTML Help Workshop with the" \
   81    -1 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
   82    -1 
   83    -1 qthelp:
   84    -1 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
   85    -1 	@echo
   86    -1 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
   87    -1 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
   88    -1 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/laneya.qhcp"
   89    -1 	@echo "To view the help file:"
   90    -1 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/laneya.qhc"
   91    -1 
   92    -1 devhelp:
   93    -1 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
   94    -1 	@echo
   95    -1 	@echo "Build finished."
   96    -1 	@echo "To view the help file:"
   97    -1 	@echo "# mkdir -p $$HOME/.local/share/devhelp/laneya"
   98    -1 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/laneya"
   99    -1 	@echo "# devhelp"
  100    -1 
  101    -1 epub:
  102    -1 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  103    -1 	@echo
  104    -1 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  105    -1 
  106    -1 latex:
  107    -1 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  108    -1 	@echo
  109    -1 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  110    -1 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
  111    -1 	      "(use \`make latexpdf' here to do that automatically)."
  112    -1 
  113    -1 latexpdf:
  114    -1 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  115    -1 	@echo "Running LaTeX files through pdflatex..."
  116    -1 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
  117    -1 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  118    -1 
  119    -1 latexpdfja:
  120    -1 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  121    -1 	@echo "Running LaTeX files through platex and dvipdfmx..."
  122    -1 	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
  123    -1 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  124    -1 
  125    -1 text:
  126    -1 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  127    -1 	@echo
  128    -1 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
  129    -1 
  130    -1 man:
  131    -1 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  132    -1 	@echo
  133    -1 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  134    -1 
  135    -1 texinfo:
  136    -1 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  137    -1 	@echo
  138    -1 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  139    -1 	@echo "Run \`make' in that directory to run these through makeinfo" \
  140    -1 	      "(use \`make info' here to do that automatically)."
  141    -1 
  142    -1 info:
  143    -1 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  144    -1 	@echo "Running Texinfo files through makeinfo..."
  145    -1 	make -C $(BUILDDIR)/texinfo info
  146    -1 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  147    -1 
  148    -1 gettext:
  149    -1 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  150    -1 	@echo
  151    -1 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  152    -1 
  153    -1 changes:
  154    -1 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  155    -1 	@echo
  156    -1 	@echo "The overview file is in $(BUILDDIR)/changes."
  157    -1 
  158    -1 linkcheck:
  159    -1 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  160    -1 	@echo
  161    -1 	@echo "Link check complete; look for any errors in the above output " \
  162    -1 	      "or in $(BUILDDIR)/linkcheck/output.txt."
  163    -1 
  164    -1 doctest:
  165    -1 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  166    -1 	@echo "Testing of doctests in the sources finished, look at the " \
  167    -1 	      "results in $(BUILDDIR)/doctest/output.txt."
  168    -1 
  169    -1 xml:
  170    -1 	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
  171    -1 	@echo
  172    -1 	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
  173    -1 
  174    -1 pseudoxml:
  175    -1 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
  176    -1 	@echo
  177    -1 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

diff --git a/docs/make.bat b/docs/make.bat

@@ -1,242 +0,0 @@
    1    -1 @ECHO OFF

    2    -1 

    3    -1 REM Command file for Sphinx documentation

    4    -1 

    5    -1 if "%SPHINXBUILD%" == "" (

    6    -1 	set SPHINXBUILD=sphinx-build

    7    -1 )

    8    -1 set BUILDDIR=build

    9    -1 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source

   10    -1 set I18NSPHINXOPTS=%SPHINXOPTS% source

   11    -1 if NOT "%PAPER%" == "" (

   12    -1 	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%

   13    -1 	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%

   14    -1 )

   15    -1 

   16    -1 if "%1" == "" goto help

   17    -1 

   18    -1 if "%1" == "help" (

   19    -1 	:help

   20    -1 	echo.Please use `make ^<target^>` where ^<target^> is one of

   21    -1 	echo.  html       to make standalone HTML files

   22    -1 	echo.  dirhtml    to make HTML files named index.html in directories

   23    -1 	echo.  singlehtml to make a single large HTML file

   24    -1 	echo.  pickle     to make pickle files

   25    -1 	echo.  json       to make JSON files

   26    -1 	echo.  htmlhelp   to make HTML files and a HTML help project

   27    -1 	echo.  qthelp     to make HTML files and a qthelp project

   28    -1 	echo.  devhelp    to make HTML files and a Devhelp project

   29    -1 	echo.  epub       to make an epub

   30    -1 	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter

   31    -1 	echo.  text       to make text files

   32    -1 	echo.  man        to make manual pages

   33    -1 	echo.  texinfo    to make Texinfo files

   34    -1 	echo.  gettext    to make PO message catalogs

   35    -1 	echo.  changes    to make an overview over all changed/added/deprecated items

   36    -1 	echo.  xml        to make Docutils-native XML files

   37    -1 	echo.  pseudoxml  to make pseudoxml-XML files for display purposes

   38    -1 	echo.  linkcheck  to check all external links for integrity

   39    -1 	echo.  doctest    to run all doctests embedded in the documentation if enabled

   40    -1 	goto end

   41    -1 )

   42    -1 

   43    -1 if "%1" == "clean" (

   44    -1 	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i

   45    -1 	del /q /s %BUILDDIR%\*

   46    -1 	goto end

   47    -1 )

   48    -1 

   49    -1 

   50    -1 %SPHINXBUILD% 2> nul

   51    -1 if errorlevel 9009 (

   52    -1 	echo.

   53    -1 	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx

   54    -1 	echo.installed, then set the SPHINXBUILD environment variable to point

   55    -1 	echo.to the full path of the 'sphinx-build' executable. Alternatively you

   56    -1 	echo.may add the Sphinx directory to PATH.

   57    -1 	echo.

   58    -1 	echo.If you don't have Sphinx installed, grab it from

   59    -1 	echo.http://sphinx-doc.org/

   60    -1 	exit /b 1

   61    -1 )

   62    -1 

   63    -1 if "%1" == "html" (

   64    -1 	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html

   65    -1 	if errorlevel 1 exit /b 1

   66    -1 	echo.

   67    -1 	echo.Build finished. The HTML pages are in %BUILDDIR%/html.

   68    -1 	goto end

   69    -1 )

   70    -1 

   71    -1 if "%1" == "dirhtml" (

   72    -1 	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml

   73    -1 	if errorlevel 1 exit /b 1

   74    -1 	echo.

   75    -1 	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.

   76    -1 	goto end

   77    -1 )

   78    -1 

   79    -1 if "%1" == "singlehtml" (

   80    -1 	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml

   81    -1 	if errorlevel 1 exit /b 1

   82    -1 	echo.

   83    -1 	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.

   84    -1 	goto end

   85    -1 )

   86    -1 

   87    -1 if "%1" == "pickle" (

   88    -1 	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle

   89    -1 	if errorlevel 1 exit /b 1

   90    -1 	echo.

   91    -1 	echo.Build finished; now you can process the pickle files.

   92    -1 	goto end

   93    -1 )

   94    -1 

   95    -1 if "%1" == "json" (

   96    -1 	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json

   97    -1 	if errorlevel 1 exit /b 1

   98    -1 	echo.

   99    -1 	echo.Build finished; now you can process the JSON files.

  100    -1 	goto end

  101    -1 )

  102    -1 

  103    -1 if "%1" == "htmlhelp" (

  104    -1 	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp

  105    -1 	if errorlevel 1 exit /b 1

  106    -1 	echo.

  107    -1 	echo.Build finished; now you can run HTML Help Workshop with the ^

  108    -1 .hhp project file in %BUILDDIR%/htmlhelp.

  109    -1 	goto end

  110    -1 )

  111    -1 

  112    -1 if "%1" == "qthelp" (

  113    -1 	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp

  114    -1 	if errorlevel 1 exit /b 1

  115    -1 	echo.

  116    -1 	echo.Build finished; now you can run "qcollectiongenerator" with the ^

  117    -1 .qhcp project file in %BUILDDIR%/qthelp, like this:

  118    -1 	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\laneya.qhcp

  119    -1 	echo.To view the help file:

  120    -1 	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\laneya.ghc

  121    -1 	goto end

  122    -1 )

  123    -1 

  124    -1 if "%1" == "devhelp" (

  125    -1 	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp

  126    -1 	if errorlevel 1 exit /b 1

  127    -1 	echo.

  128    -1 	echo.Build finished.

  129    -1 	goto end

  130    -1 )

  131    -1 

  132    -1 if "%1" == "epub" (

  133    -1 	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub

  134    -1 	if errorlevel 1 exit /b 1

  135    -1 	echo.

  136    -1 	echo.Build finished. The epub file is in %BUILDDIR%/epub.

  137    -1 	goto end

  138    -1 )

  139    -1 

  140    -1 if "%1" == "latex" (

  141    -1 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex

  142    -1 	if errorlevel 1 exit /b 1

  143    -1 	echo.

  144    -1 	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.

  145    -1 	goto end

  146    -1 )

  147    -1 

  148    -1 if "%1" == "latexpdf" (

  149    -1 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex

  150    -1 	cd %BUILDDIR%/latex

  151    -1 	make all-pdf

  152    -1 	cd %BUILDDIR%/..

  153    -1 	echo.

  154    -1 	echo.Build finished; the PDF files are in %BUILDDIR%/latex.

  155    -1 	goto end

  156    -1 )

  157    -1 

  158    -1 if "%1" == "latexpdfja" (

  159    -1 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex

  160    -1 	cd %BUILDDIR%/latex

  161    -1 	make all-pdf-ja

  162    -1 	cd %BUILDDIR%/..

  163    -1 	echo.

  164    -1 	echo.Build finished; the PDF files are in %BUILDDIR%/latex.

  165    -1 	goto end

  166    -1 )

  167    -1 

  168    -1 if "%1" == "text" (

  169    -1 	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text

  170    -1 	if errorlevel 1 exit /b 1

  171    -1 	echo.

  172    -1 	echo.Build finished. The text files are in %BUILDDIR%/text.

  173    -1 	goto end

  174    -1 )

  175    -1 

  176    -1 if "%1" == "man" (

  177    -1 	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man

  178    -1 	if errorlevel 1 exit /b 1

  179    -1 	echo.

  180    -1 	echo.Build finished. The manual pages are in %BUILDDIR%/man.

  181    -1 	goto end

  182    -1 )

  183    -1 

  184    -1 if "%1" == "texinfo" (

  185    -1 	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo

  186    -1 	if errorlevel 1 exit /b 1

  187    -1 	echo.

  188    -1 	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.

  189    -1 	goto end

  190    -1 )

  191    -1 

  192    -1 if "%1" == "gettext" (

  193    -1 	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale

  194    -1 	if errorlevel 1 exit /b 1

  195    -1 	echo.

  196    -1 	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.

  197    -1 	goto end

  198    -1 )

  199    -1 

  200    -1 if "%1" == "changes" (

  201    -1 	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes

  202    -1 	if errorlevel 1 exit /b 1

  203    -1 	echo.

  204    -1 	echo.The overview file is in %BUILDDIR%/changes.

  205    -1 	goto end

  206    -1 )

  207    -1 

  208    -1 if "%1" == "linkcheck" (

  209    -1 	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck

  210    -1 	if errorlevel 1 exit /b 1

  211    -1 	echo.

  212    -1 	echo.Link check complete; look for any errors in the above output ^

  213    -1 or in %BUILDDIR%/linkcheck/output.txt.

  214    -1 	goto end

  215    -1 )

  216    -1 

  217    -1 if "%1" == "doctest" (

  218    -1 	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest

  219    -1 	if errorlevel 1 exit /b 1

  220    -1 	echo.

  221    -1 	echo.Testing of doctests in the sources finished, look at the ^

  222    -1 results in %BUILDDIR%/doctest/output.txt.

  223    -1 	goto end

  224    -1 )

  225    -1 

  226    -1 if "%1" == "xml" (

  227    -1 	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml

  228    -1 	if errorlevel 1 exit /b 1

  229    -1 	echo.

  230    -1 	echo.Build finished. The XML files are in %BUILDDIR%/xml.

  231    -1 	goto end

  232    -1 )

  233    -1 

  234    -1 if "%1" == "pseudoxml" (

  235    -1 	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml

  236    -1 	if errorlevel 1 exit /b 1

  237    -1 	echo.

  238    -1 	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.

  239    -1 	goto end

  240    -1 )

  241    -1 

  242    -1 :end

diff --git a/docs/source/actions.rst b/docs/source/actions.rst

@@ -1,5 +0,0 @@
    1    -1 Available actions
    2    -1 =================
    3    -1 
    4    -1 .. automodule:: laneya.actions
    5    -1     :members:

diff --git a/docs/source/conf.py b/docs/source/conf.py

@@ -1,265 +0,0 @@
    1    -1 # -*- coding: utf-8 -*-
    2    -1 #
    3    -1 # laneya documentation build configuration file, created by
    4    -1 # sphinx-quickstart on Sat Oct  4 08:02:06 2014.
    5    -1 #
    6    -1 # This file is execfile()d with the current directory set to its
    7    -1 # containing dir.
    8    -1 #
    9    -1 # Note that not all possible configuration values are present in this
   10    -1 # autogenerated file.
   11    -1 #
   12    -1 # All configuration values have a default; values that are commented out
   13    -1 # serve to show the default.
   14    -1 
   15    -1 import sys
   16    -1 import os
   17    -1 
   18    -1 # If extensions (or modules to document with autodoc) are in another directory,
   19    -1 # add these directories to sys.path here. If the directory is relative to the
   20    -1 # documentation root, use os.path.abspath to make it absolute, like shown here.
   21    -1 #sys.path.insert(0, os.path.abspath('.'))
   22    -1 
   23    -1 # -- General configuration ------------------------------------------------
   24    -1 
   25    -1 # If your documentation needs a minimal Sphinx version, state it here.
   26    -1 #needs_sphinx = '1.0'
   27    -1 
   28    -1 # Add any Sphinx extension module names here, as strings. They can be
   29    -1 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   30    -1 # ones.
   31    -1 extensions = [
   32    -1     'sphinx.ext.autodoc',
   33    -1     'sphinx.ext.intersphinx',
   34    -1 ]
   35    -1 
   36    -1 # Add any paths that contain templates here, relative to this directory.
   37    -1 # templates_path = ['_templates']
   38    -1 
   39    -1 # The suffix of source filenames.
   40    -1 source_suffix = '.rst'
   41    -1 
   42    -1 # The encoding of source files.
   43    -1 #source_encoding = 'utf-8-sig'
   44    -1 
   45    -1 # The master toctree document.
   46    -1 master_doc = 'index'
   47    -1 
   48    -1 # General information about the project.
   49    -1 project = u'laneya'
   50    -1 copyright = u'2014, Tobias Bengfort'
   51    -1 
   52    -1 # The version info for the project you're documenting, acts as replacement for
   53    -1 # |version| and |release|, also used in various other places throughout the
   54    -1 # built documents.
   55    -1 #
   56    -1 # The short X.Y version.
   57    -1 version = '0.0.0'
   58    -1 # The full version, including alpha/beta/rc tags.
   59    -1 release = '0.0.0'
   60    -1 
   61    -1 # The language for content autogenerated by Sphinx. Refer to documentation
   62    -1 # for a list of supported languages.
   63    -1 #language = None
   64    -1 
   65    -1 # There are two options for replacing |today|: either, you set today to some
   66    -1 # non-false value, then it is used:
   67    -1 #today = ''
   68    -1 # Else, today_fmt is used as the format for a strftime call.
   69    -1 #today_fmt = '%B %d, %Y'
   70    -1 
   71    -1 # List of patterns, relative to source directory, that match files and
   72    -1 # directories to ignore when looking for source files.
   73    -1 exclude_patterns = []
   74    -1 
   75    -1 # The reST default role (used for this markup: `text`) to use for all
   76    -1 # documents.
   77    -1 #default_role = None
   78    -1 
   79    -1 # If true, '()' will be appended to :func: etc. cross-reference text.
   80    -1 #add_function_parentheses = True
   81    -1 
   82    -1 # If true, the current module name will be prepended to all description
   83    -1 # unit titles (such as .. function::).
   84    -1 #add_module_names = True
   85    -1 
   86    -1 # If true, sectionauthor and moduleauthor directives will be shown in the
   87    -1 # output. They are ignored by default.
   88    -1 #show_authors = False
   89    -1 
   90    -1 # The name of the Pygments (syntax highlighting) style to use.
   91    -1 pygments_style = 'sphinx'
   92    -1 
   93    -1 # A list of ignored prefixes for module index sorting.
   94    -1 #modindex_common_prefix = []
   95    -1 
   96    -1 # If true, keep warnings as "system message" paragraphs in the built documents.
   97    -1 #keep_warnings = False
   98    -1 
   99    -1 
  100    -1 # -- Options for HTML output ----------------------------------------------
  101    -1 
  102    -1 # The theme to use for HTML and HTML Help pages.  See the documentation for
  103    -1 # a list of builtin themes.
  104    -1 html_theme = 'default'
  105    -1 
  106    -1 # Theme options are theme-specific and customize the look and feel of a theme
  107    -1 # further.  For a list of options available for each theme, see the
  108    -1 # documentation.
  109    -1 #html_theme_options = {}
  110    -1 
  111    -1 # Add any paths that contain custom themes here, relative to this directory.
  112    -1 #html_theme_path = []
  113    -1 
  114    -1 # The name for this set of Sphinx documents.  If None, it defaults to
  115    -1 # "<project> v<release> documentation".
  116    -1 #html_title = None
  117    -1 
  118    -1 # A shorter title for the navigation bar.  Default is the same as html_title.
  119    -1 #html_short_title = None
  120    -1 
  121    -1 # The name of an image file (relative to this directory) to place at the top
  122    -1 # of the sidebar.
  123    -1 #html_logo = None
  124    -1 
  125    -1 # The name of an image file (within the static path) to use as favicon of the
  126    -1 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  127    -1 # pixels large.
  128    -1 #html_favicon = None
  129    -1 
  130    -1 # Add any paths that contain custom static files (such as style sheets) here,
  131    -1 # relative to this directory. They are copied after the builtin static files,
  132    -1 # so a file named "default.css" will overwrite the builtin "default.css".
  133    -1 # html_static_path = ['_static']
  134    -1 
  135    -1 # Add any extra paths that contain custom files (such as robots.txt or
  136    -1 # .htaccess) here, relative to this directory. These files are copied
  137    -1 # directly to the root of the documentation.
  138    -1 #html_extra_path = []
  139    -1 
  140    -1 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  141    -1 # using the given strftime format.
  142    -1 #html_last_updated_fmt = '%b %d, %Y'
  143    -1 
  144    -1 # If true, SmartyPants will be used to convert quotes and dashes to
  145    -1 # typographically correct entities.
  146    -1 #html_use_smartypants = True
  147    -1 
  148    -1 # Custom sidebar templates, maps document names to template names.
  149    -1 #html_sidebars = {}
  150    -1 
  151    -1 # Additional templates that should be rendered to pages, maps page names to
  152    -1 # template names.
  153    -1 #html_additional_pages = {}
  154    -1 
  155    -1 # If false, no module index is generated.
  156    -1 #html_domain_indices = True
  157    -1 
  158    -1 # If false, no index is generated.
  159    -1 #html_use_index = True
  160    -1 
  161    -1 # If true, the index is split into individual pages for each letter.
  162    -1 #html_split_index = False
  163    -1 
  164    -1 # If true, links to the reST sources are added to the pages.
  165    -1 #html_show_sourcelink = True
  166    -1 
  167    -1 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  168    -1 #html_show_sphinx = True
  169    -1 
  170    -1 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  171    -1 #html_show_copyright = True
  172    -1 
  173    -1 # If true, an OpenSearch description file will be output, and all pages will
  174    -1 # contain a <link> tag referring to it.  The value of this option must be the
  175    -1 # base URL from which the finished HTML is served.
  176    -1 #html_use_opensearch = ''
  177    -1 
  178    -1 # This is the file name suffix for HTML files (e.g. ".xhtml").
  179    -1 #html_file_suffix = None
  180    -1 
  181    -1 # Output file base name for HTML help builder.
  182    -1 htmlhelp_basename = 'laneyadoc'
  183    -1 
  184    -1 
  185    -1 # -- Options for LaTeX output ---------------------------------------------
  186    -1 
  187    -1 latex_elements = {
  188    -1 # The paper size ('letterpaper' or 'a4paper').
  189    -1 #'papersize': 'letterpaper',
  190    -1 
  191    -1 # The font size ('10pt', '11pt' or '12pt').
  192    -1 #'pointsize': '10pt',
  193    -1 
  194    -1 # Additional stuff for the LaTeX preamble.
  195    -1 #'preamble': '',
  196    -1 }
  197    -1 
  198    -1 # Grouping the document tree into LaTeX files. List of tuples
  199    -1 # (source start file, target name, title,
  200    -1 #  author, documentclass [howto, manual, or own class]).
  201    -1 latex_documents = [
  202    -1   ('index', 'laneya.tex', u'laneya Documentation',
  203    -1    u'Tobias Bengfort', 'manual'),
  204    -1 ]
  205    -1 
  206    -1 # The name of an image file (relative to this directory) to place at the top of
  207    -1 # the title page.
  208    -1 #latex_logo = None
  209    -1 
  210    -1 # For "manual" documents, if this is true, then toplevel headings are parts,
  211    -1 # not chapters.
  212    -1 #latex_use_parts = False
  213    -1 
  214    -1 # If true, show page references after internal links.
  215    -1 #latex_show_pagerefs = False
  216    -1 
  217    -1 # If true, show URL addresses after external links.
  218    -1 #latex_show_urls = False
  219    -1 
  220    -1 # Documents to append as an appendix to all manuals.
  221    -1 #latex_appendices = []
  222    -1 
  223    -1 # If false, no module index is generated.
  224    -1 #latex_domain_indices = True
  225    -1 
  226    -1 
  227    -1 # -- Options for manual page output ---------------------------------------
  228    -1 
  229    -1 # One entry per manual page. List of tuples
  230    -1 # (source start file, name, description, authors, manual section).
  231    -1 man_pages = [
  232    -1     ('index', 'laneya', u'laneya Documentation',
  233    -1      [u'Tobias Bengfort'], 1)
  234    -1 ]
  235    -1 
  236    -1 # If true, show URL addresses after external links.
  237    -1 #man_show_urls = False
  238    -1 
  239    -1 
  240    -1 # -- Options for Texinfo output -------------------------------------------
  241    -1 
  242    -1 # Grouping the document tree into Texinfo files. List of tuples
  243    -1 # (source start file, target name, title, author,
  244    -1 #  dir menu entry, description, category)
  245    -1 texinfo_documents = [
  246    -1   ('index', 'laneya', u'laneya Documentation',
  247    -1    u'Tobias Bengfort', 'laneya', 'One line description of project.',
  248    -1    'Miscellaneous'),
  249    -1 ]
  250    -1 
  251    -1 # Documents to append as an appendix to all manuals.
  252    -1 #texinfo_appendices = []
  253    -1 
  254    -1 # If false, no module index is generated.
  255    -1 #texinfo_domain_indices = True
  256    -1 
  257    -1 # How to display URL addresses: 'footnote', 'no', or 'inline'.
  258    -1 #texinfo_show_urls = 'footnote'
  259    -1 
  260    -1 # If true, do not generate a @detailmenu in the "Top" node's menu.
  261    -1 #texinfo_no_detailmenu = False
  262    -1 
  263    -1 
  264    -1 # Example configuration for intersphinx: refer to the Python standard library.
  265    -1 intersphinx_mapping = {'http://docs.python.org/': None}

diff --git a/docs/source/deferred.rst b/docs/source/deferred.rst

@@ -1,6 +0,0 @@
    1    -1 Deferred
    2    -1 ========
    3    -1 
    4    -1 .. automodule:: laneya.deferred
    5    -1     :members:
    6    -1     :undoc-members:

diff --git a/docs/source/index.rst b/docs/source/index.rst

@@ -1,21 +0,0 @@
    1    -1 Welcome to laneya's documentation!
    2    -1 ==================================
    3    -1 
    4    -1 Contents
    5    -1 --------
    6    -1 
    7    -1 .. toctree::
    8    -1     :maxdepth: 2
    9    -1 
   10    -1     quickstart
   11    -1     protocol
   12    -1     actions
   13    -1     map
   14    -1     deferred
   15    -1 
   16    -1 Indices and tables
   17    -1 ------------------
   18    -1 
   19    -1 * :ref:`genindex`
   20    -1 * :ref:`modindex`
   21    -1 * :ref:`search`

diff --git a/docs/source/map.rst b/docs/source/map.rst

@@ -1,6 +0,0 @@
    1    -1 Map and Sprites
    2    -1 ===============
    3    -1 
    4    -1 .. automodule:: laneya.map
    5    -1     :members:
    6    -1     :show-inheritance:

diff --git a/docs/source/protocol.rst b/docs/source/protocol.rst

@@ -1,5 +0,0 @@
    1    -1 Protocol
    2    -1 ========
    3    -1 
    4    -1 .. automodule:: laneya.protocol
    5    -1     :members:

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst

@@ -1,4 +0,0 @@
    1    -1 Quickstart
    2    -1 ==========
    3    -1 
    4    -1 .. include:: ../../README.rst

diff --git a/setup.cfg b/setup.cfg

@@ -8,8 +8,3 @@ cover-html=1
    8     8 
    9     9 [flake8]
   10    10 exclude=.env,.tox,.git,build,dist,docs
   11    -1 
   12    -1 [build_sphinx]
   13    -1 source-dir = docs/source
   14    -1 build-dir  = docs/build
   15    -1 all-files = 1