Issue 43 (#207)
* squach contents new branch * source code explanations * flake8 * change in requirements * modified: docs/source/code.rst modified: docs/source/plugins.rst * modified: docs/source/code.rst modified: pygeoapi/formatter/csv_.py modified: pygeoapi/provider/geojson.py * changes requred in review code * modified: .travis.yml missing " * change file to use requirements-dev.txt modified: readthedocs.yml * flask_cors removal from requirements.txt * text changes
This commit is contained in:
committed by
Tom Kralidis
parent
5ab45769db
commit
da267e9ed3
@@ -0,0 +1,219 @@
|
||||
.. _code:
|
||||
|
||||
|
||||
|
||||
Code documentation
|
||||
==================
|
||||
|
||||
Top level code documentation. Follow link in section for module/class member information
|
||||
|
||||
|
||||
API
|
||||
---
|
||||
|
||||
|
||||
.. automodule:: pygeoapi.api
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
|
||||
flask_app
|
||||
---------
|
||||
|
||||
.. automodule:: pygeoapi.flask_app
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
|
||||
Logging
|
||||
-------
|
||||
|
||||
|
||||
.. automodule:: pygeoapi.log
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
|
||||
OpenAPI
|
||||
-------
|
||||
|
||||
.. automodule:: pygeoapi.openapi
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
Plugins
|
||||
-------
|
||||
|
||||
.. note:: Please consult section :ref:`plugins`
|
||||
|
||||
|
||||
.. automodule:: pygeoapi.plugin
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
Utils
|
||||
-----
|
||||
|
||||
.. automodule:: pygeoapi.util
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
Formatter package
|
||||
-----------------
|
||||
|
||||
|
||||
.. automodule:: pygeoapi.formatter
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
Base class
|
||||
^^^^^^^^^^
|
||||
.. automodule:: pygeoapi.formatter.base
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
csv
|
||||
^^^
|
||||
|
||||
.. automodule:: pygeoapi.formatter.csv_
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
Process package
|
||||
---------------
|
||||
|
||||
.. automodule:: pygeoapi.process
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
Base class
|
||||
^^^^^^^^^^
|
||||
|
||||
.. automodule:: pygeoapi.process.base
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
hello_world
|
||||
^^^^^^^^^^^
|
||||
|
||||
Hello world example process
|
||||
|
||||
.. automodule:: pygeoapi.process.hello_world
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
.. _data Provider:
|
||||
|
||||
Provider
|
||||
--------
|
||||
|
||||
|
||||
|
||||
.. automodule:: pygeoapi.provider
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
|
||||
Base class
|
||||
^^^^^^^^^^
|
||||
|
||||
.. automodule:: pygeoapi.provider.base
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members:
|
||||
|
||||
|
||||
CSV provider
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. automodule:: pygeoapi.provider.csv_
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
|
||||
Elastic provider
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. automodule:: pygeoapi.provider.elasticsearch_
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
|
||||
|
||||
GeoJSON
|
||||
^^^^^^^
|
||||
|
||||
.. automodule:: pygeoapi.provider.geojson
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
|
||||
|
||||
GeoPackage
|
||||
^^^^^^^^^^
|
||||
|
||||
.. automodule:: pygeoapi.provider.geopackage
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
|
||||
|
||||
OGR
|
||||
^^^
|
||||
|
||||
.. automodule:: pygeoapi.provider.ogr
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
|
||||
|
||||
postgresql
|
||||
^^^^^^^^^^
|
||||
|
||||
.. automodule:: pygeoapi.provider.postgresql
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
|
||||
|
||||
sqlite
|
||||
^^^^^^
|
||||
|
||||
.. automodule:: pygeoapi.provider.sqlite
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:private-members:
|
||||
Reference in New Issue
Block a user