From 15989e7c61d23ba16745a2394a87d46b6f7675de Mon Sep 17 00:00:00 2001 From: "Sean C. Gillies" Date: Mon, 24 Sep 2018 14:34:44 -0600 Subject: [PATCH] Update apidocs, remove extra obsolete apidoc dir --- apidocs/Makefile | 20 ----- apidocs/apidocs.rst | 7 -- apidocs/conf.py | 170 ----------------------------------- apidocs/index.rst | 10 --- apidocs/make.bat | 36 -------- apidocs/mapbox.rst | 29 ------ apidocs/mapbox.services.rst | 106 ---------------------- apidocs/modules.rst | 7 -- docs/api/mapbox.services.rst | 8 ++ 9 files changed, 8 insertions(+), 385 deletions(-) delete mode 100644 apidocs/Makefile delete mode 100644 apidocs/apidocs.rst delete mode 100644 apidocs/conf.py delete mode 100644 apidocs/index.rst delete mode 100644 apidocs/make.bat delete mode 100644 apidocs/mapbox.rst delete mode 100644 apidocs/mapbox.services.rst delete mode 100644 apidocs/modules.rst diff --git a/apidocs/Makefile b/apidocs/Makefile deleted file mode 100644 index e4308c5..0000000 --- a/apidocs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = python -msphinx -SPHINXPROJ = mapbox-sdk-py -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) \ No newline at end of file diff --git a/apidocs/apidocs.rst b/apidocs/apidocs.rst deleted file mode 100644 index 1cdfefe..0000000 --- a/apidocs/apidocs.rst +++ /dev/null @@ -1,7 +0,0 @@ -Mapbox Python SDK API Docs -========================== - -.. toctree:: - :maxdepth: 4 - - mapbox diff --git a/apidocs/conf.py b/apidocs/conf.py deleted file mode 100644 index 548cc54..0000000 --- a/apidocs/conf.py +++ /dev/null @@ -1,170 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# mapbox-sdk-py documentation build configuration file, created by -# sphinx-quickstart on Fri Jul 7 10:55:50 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.napoleon'] - -napoleon_google_docstring = False -napoleon_use_param = False -napoleon_use_ivar = True - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# 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 = 'mapbox-sdk-py' -copyright = '2017, Mapbox' -author = 'Mapbox' - -# 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. -# -# The short X.Y version. -version = '' -# The full version, including alpha/beta/rc tags. -release = '' - -# 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 = ['_build', 'Thumbs.db', '.DS_Store'] - -# 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 = 'alabaster' -# html_theme = 'sphinx_rtd_theme' -html_theme = 'nature' - - -# 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 = {} -# For use with sphinx_rtd_theme -# 'collapse_navigation': False, -# 'display_version': True, -# 'navigation_depth': 3, - -# 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 = ['_static'] - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'mapbox-sdk-pydoc' - - -# -- 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, 'mapbox-sdk-py.tex', 'mapbox-sdk-py Documentation', - 'Mapbox', '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, 'mapbox-sdk-py', 'mapbox-sdk-py 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, 'mapbox-sdk-py', 'mapbox-sdk-py Documentation', - author, 'mapbox-sdk-py', 'One line description of project.', - 'Miscellaneous'), -] - - - diff --git a/apidocs/index.rst b/apidocs/index.rst deleted file mode 100644 index b97855f..0000000 --- a/apidocs/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. include:: ../README.rst - -API Documentation -================== - -.. toctree:: - :maxdepth: 4 - - mapbox.services - mapbox diff --git a/apidocs/make.bat b/apidocs/make.bat deleted file mode 100644 index 3b2d32a..0000000 --- a/apidocs/make.bat +++ /dev/null @@ -1,36 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=python -msphinx -) -set SOURCEDIR=. -set BUILDDIR=_build -set SPHINXPROJ=mapbox-sdk-py - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The Sphinx module was not found. Make sure you have Sphinx installed, - echo.then set the SPHINXBUILD environment variable to point to the full - echo.path of the 'sphinx-build' executable. Alternatively you may add the - echo.Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd diff --git a/apidocs/mapbox.rst b/apidocs/mapbox.rst deleted file mode 100644 index 6a1905e..0000000 --- a/apidocs/mapbox.rst +++ /dev/null @@ -1,29 +0,0 @@ - -mapbox\.encoding ------------------------ - -.. automodule:: mapbox.encoding - :members: - :undoc-members: - :show-inheritance: - -mapbox\.errors ---------------------- - -.. automodule:: mapbox.errors - :members: - :undoc-members: - :show-inheritance: - -mapbox\.utils --------------------- - -.. automodule:: mapbox.utils - :members: - :undoc-members: - :show-inheritance: - -.. automodule:: mapbox - :members: - :undoc-members: - :show-inheritance: diff --git a/apidocs/mapbox.services.rst b/apidocs/mapbox.services.rst deleted file mode 100644 index b624292..0000000 --- a/apidocs/mapbox.services.rst +++ /dev/null @@ -1,106 +0,0 @@ -:tocdepth: 4 - -mapbox\.services -================ - -mapbox\.services\.analytics ----------------------------------- - -.. automodule:: mapbox.services.analytics - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.base ------------------------------ - -.. automodule:: mapbox.services.base - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.datasets ---------------------------------- - -.. automodule:: mapbox.services.datasets - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.directions ------------------------------------ - -.. automodule:: mapbox.services.directions - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.distance ---------------------------------- - -.. automodule:: mapbox.services.distance - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.geocoding ----------------------------------- - -.. automodule:: mapbox.services.geocoding - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.mapmatching ------------------------------------- - -.. automodule:: mapbox.services.mapmatching - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.static -------------------------------- - -.. automodule:: mapbox.services.static - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.static\_style --------------------------------------- - -.. automodule:: mapbox.services.static_style - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.surface --------------------------------- - -.. automodule:: mapbox.services.surface - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.tilequery ---------------------------- - -.. automodule:: mapbox.services.tilequery - :members: - :undoc-members: - :show-inheritance: - -mapbox\.services\.uploads --------------------------------- - -.. automodule:: mapbox.services.uploads - :members: - :undoc-members: - :show-inheritance: - - -.. automodule:: mapbox.services - :members: - :undoc-members: - :show-inheritance: diff --git a/apidocs/modules.rst b/apidocs/modules.rst deleted file mode 100644 index 91e8f87..0000000 --- a/apidocs/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -mapbox -====== - -.. toctree:: - :maxdepth: 4 - - mapbox diff --git a/docs/api/mapbox.services.rst b/docs/api/mapbox.services.rst index 57d78c2..2a4e510 100644 --- a/docs/api/mapbox.services.rst +++ b/docs/api/mapbox.services.rst @@ -76,6 +76,14 @@ mapbox.services.static\_style module :undoc-members: :show-inheritance: +mapbox.services.tilequery module +-------------------------------- + +.. automodule:: mapbox.services.tilequery + :members: + :undoc-members: + :show-inheritance: + mapbox.services.uploads module ------------------------------