dev

README.rst

@@ -6,7 +6,7 @@ meintile
     :target: https://travis-ci.org/EOX-A/meintile
 
 .. image:: https://coveralls.io/repos/github/EOX-A/meintile/badge.svg?branch=master
-:target: https://coveralls.io/github/EOX-A/meintile?branch=master
+    :target: https://coveralls.io/github/EOX-A/meintile?branch=master
 
 
 successor of https://github.com/ungarj/tilematrix oriented on OGC Two Dimensional Tile Matrix Set

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = meintile
+SOURCEDIR     = source
+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/README.rst

@@ -0,0 +1,12 @@
+====================
+Create Documentation
+====================
+
+--------------------------
+Generate API Documentation
+--------------------------
+
+.. code-block:: shell
+
+    pip install -r source/requirements.txt
+    sphinx-apidoc -fe -o source/apidoc/ ../meintile ../meintile/wkss/* -H "API Reference"

docs/source/apidoc/meintile.exceptions.rst

@@ -0,0 +1,7 @@
+meintile.exceptions module
+==========================
+
+.. automodule:: meintile.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/apidoc/meintile.rst

@@ -0,0 +1,17 @@
+meintile package
+================
+
+Submodules
+----------
+
+.. toctree::
+
+   meintile.exceptions
+
+Module contents
+---------------
+
+.. automodule:: meintile
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/apidoc/modules.rst

@@ -0,0 +1,7 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   meintile

docs/source/changelog_link.rst

@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.rst

docs/source/conf.py

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+#
+# meintile documentation build configuration file, created by
+# sphinx-quickstart on Fri Feb 24 21:39:27 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../"))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary", "numpydoc"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["ntemplates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = u"meintile"
+copyright = u"2019, EOX IT Services"
+author = u"Joachim Ungar"
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+with open("../../meintile/__init__.py") as f:
+    for line in f:
+        if line.find("__version__") >= 0:
+            version = line.split("=")[1].strip().strip('"').strip("'")
+            break
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["nstatic"]
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "meintiledoc"
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, "meintile.tex", u"meintile Documentation", u"Joachim Ungar", "manual")
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "meintile", u"meintile Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "meintile",
+        u"meintile Documentation",
+        author,
+        "meintile",
+        "meintile bla bla.",
+        "GIS",
+    )
+]
+
+# numpydoc fix
+numpydoc_show_class_members = False
+
+autodoc_mock_imports = ["affine", "rasterio.crs"]

docs/source/index.rst

@@ -0,0 +1,18 @@
+meintile
+========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   apidoc/modules
+   changelog_link
+   license_link
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/installation.rst

@@ -0,0 +1,24 @@
+============
+Installation
+============
+
+Use ``pip`` to install the latest stable version:
+
+.. code-block:: shell
+
+    $ pip install meintile
+
+Manually install the latest development version
+
+.. code-block:: shell
+
+    $ git clone git@github.com:EOX-A/meintile.git
+    $ pip install -e meintile[dev]
+
+
+To make sure Rasterio is properly built against your local GDAL installation, don't
+install the binaries but build them on your system:
+
+.. code-block:: shell
+
+    $ pip install --upgrade rasterio --no-binary :all:

docs/source/license_link.rst

@@ -0,0 +1,4 @@
+License
+=======
+
+.. include:: ../../LICENSE

docs/source/requirements.txt

@@ -0,0 +1,4 @@
+numpydoc>=0.6.0
+sphinxcontrib-autodoc-doxygen>=0.3.2
+sphinx_rtd_theme
+mock