:update: docs directory related to readthedocs requirements

README.rst

@@ -1,7 +1,7 @@
 Description
 -----------
 
-Common tools useful to python projects.
+Utilities for Python.
 
 .. image:: https://img.shields.io/pypi/l/b3j0f.utils.svg
    :target: https://pypi.python.org/pypi/b3j0f.utils/
@@ -24,6 +24,10 @@ Common tools useful to python projects.
    :alt: Supported Python implementations
 
 .. image:: https://img.shields.io/pypi/wheel/b3j0f.utils.svg
+   :target: https://travis-ci.org/b3j0f/utils
+   :alt: Download format
+
+.. image:: https://travis-ci.org/b3j0f/utils.svg?branch=develop
    :target: https://travis-ci.org/b3j0f/utils
    :alt: Build status
 
@@ -35,6 +39,10 @@ Common tools useful to python projects.
    :target: https://pypi.python.org/pypi/b3j0f.utils/
    :alt: Downloads
 
+.. image:: https://readthedocs.org/projects/b3j0futils/badge/?version=develop
+   :target: https://readthedocs.org/projects/b3j0futils/?badge=develop
+   :alt: Documentation Status
+
 Links
 -----
 

docs/changelog.rst → changelog.rst

@@ -1,6 +1,11 @@
 ChangeLog
 =========
 
+0.9.3 (14/06/15)
+----------------
+
+- add docs directory in order to be hosted by readthedocs.
+
 0.9.2 (13/06/15)
 ----------------
 

docs/Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = build
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -15,11 +15,11 @@ endif
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 # the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.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"
@@ -30,6 +30,7 @@ help:
 	@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 "  applehelp  to make an Apple Help Book"
 	@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"
@@ -45,6 +46,7 @@ help:
 	@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)/*
@@ -89,6 +91,14 @@ qthelp:
 	@echo "To view the help file:"
 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/b3j0futils.qhc"
 
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
@@ -166,6 +176,11 @@ 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

docs/make.bat

@@ -5,9 +5,9 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-set I18NSPHINXOPTS=%SPHINXOPTS% .
+set BUILDDIR=build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
+set I18NSPHINXOPTS=%SPHINXOPTS% source
 if NOT "%PAPER%" == "" (
 	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
@@ -37,6 +37,7 @@ if "%1" == "help" (
 	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
 	goto end
 )
 
@@ -47,6 +48,14 @@ if "%1" == "clean" (
 )
 
 
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
 %SPHINXBUILD% 2> nul
 if errorlevel 9009 (
 	echo.
@@ -60,6 +69,9 @@ if errorlevel 9009 (
 	exit /b 1
 )
 
+:sphinx_ok
+
+
 if "%1" == "html" (
 	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 	if errorlevel 1 exit /b 1
@@ -149,7 +161,7 @@ if "%1" == "latexpdf" (
 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
 	cd %BUILDDIR%/latex
 	make all-pdf
-	cd %BUILDDIR%/..
+	cd %~dp0
 	echo.
 	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
 	goto end
@@ -159,7 +171,7 @@ if "%1" == "latexpdfja" (
 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
 	cd %BUILDDIR%/latex
 	make all-pdf-ja
-	cd %BUILDDIR%/..
+	cd %~dp0
 	echo.
 	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
 	goto end
@@ -223,6 +235,15 @@ results in %BUILDDIR%/doctest/output.txt.
 	goto end
 )
 
+if "%1" == "coverage" (
+	%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of coverage in the sources finished, look at the ^
+results in %BUILDDIR%/coverage/python.txt.
+	goto end
+)
+
 if "%1" == "xml" (
 	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
 	if errorlevel 1 exit /b 1

docs/source/b3j0f.rst

@@ -0,0 +1,17 @@
+b3j0f package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    b3j0f.utils
+
+Module contents
+---------------
+
+.. automodule:: b3j0f
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.chaining.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.chaining module
+===========================
+
+.. automodule:: b3j0f.utils.chaining
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.iterable.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.iterable module
+===========================
+
+.. automodule:: b3j0f.utils.iterable
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.path.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.path module
+=======================
+
+.. automodule:: b3j0f.utils.path
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.property.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.property module
+===========================
+
+.. automodule:: b3j0f.utils.property
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.proxy.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.proxy module
+========================
+
+.. automodule:: b3j0f.utils.proxy
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.reflect.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.reflect module
+==========================
+
+.. automodule:: b3j0f.utils.reflect
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.rst

@@ -0,0 +1,32 @@
+b3j0f.utils package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    b3j0f.utils.test
+
+Submodules
+----------
+
+.. toctree::
+
+   b3j0f.utils.chaining
+   b3j0f.utils.iterable
+   b3j0f.utils.path
+   b3j0f.utils.property
+   b3j0f.utils.proxy
+   b3j0f.utils.reflect
+   b3j0f.utils.runtime
+   b3j0f.utils.ut
+   b3j0f.utils.version
+
+Module contents
+---------------
+
+.. automodule:: b3j0f.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.runtime.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.runtime module
+==========================
+
+.. automodule:: b3j0f.utils.runtime
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.test.chaining.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.test.chaining module
+================================
+
+.. automodule:: b3j0f.utils.test.chaining
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.test.iterable.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.test.iterable module
+================================
+
+.. automodule:: b3j0f.utils.test.iterable
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.test.path.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.test.path module
+============================
+
+.. automodule:: b3j0f.utils.test.path
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.test.property.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.test.property module
+================================
+
+.. automodule:: b3j0f.utils.test.property
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.test.proxy.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.test.proxy module
+=============================
+
+.. automodule:: b3j0f.utils.test.proxy
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/b3j0f.utils.test.reflect.rst

@@ -0,0 +1,7 @@
+b3j0f.utils.test.reflect module
+===============================
+
+.. automodule:: b3j0f.utils.test.reflect
+    :members:
+    :undoc-members:
+    :show-inheritance: