Skip to content

Commit d5dfb72

Browse files
authored
docs: rename publishing section (#2128)
* docs: rename publishing section * fix ref
1 parent 05d9ca9 commit d5dfb72

File tree

12 files changed

+62
-52
lines changed

12 files changed

+62
-52
lines changed

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def __getattr__(cls, name):
9393
# You can specify multiple suffix as a list of string:
9494
#
9595
# source_suffix = ['.rst', '.md']
96-
source_suffix = '.rst'
96+
source_suffix = {'.rst': 'restructuredtext'}
9797

9898
# The master toctree document.
9999
master_doc = 'index'

docs/source/data-publishing/index.rst

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ reference documentation on all aspects of the project.
3737
running-with-docker
3838
tour
3939
openapi
40-
data-publishing/index
40+
publishing/index
4141
transactions
4242
admin-api
4343
security

docs/source/publishing/index.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _publishing:
2+
3+
Publishing
4+
==========
5+
6+
Let's start working on integrating your data, metadata, and processes. pygeoapi provides the capability to
7+
publish vector/coverage data, catalogues, processes and exposing filesystems of geospatial data.
8+
9+
A key component of publishing is the pygeoapi plugin framework (data/metadata providers, processes). Default/core
10+
plugins are described below.
11+
12+
.. seealso::
13+
:ref:`plugins` for writing custom plugins.
14+
15+
Data publishing
16+
---------------
17+
18+
Data providers allow for configuring data files, databases, search indexes, other APIs, cloud storage,
19+
to be able to return back data to the pygeoapi API framework in a plug and play fashion.
20+
21+
.. toctree::
22+
:maxdepth: 2
23+
24+
ogcapi-features
25+
ogcapi-coverages
26+
ogcapi-maps
27+
ogcapi-tiles
28+
ogcapi-edr
29+
30+
.. seealso::
31+
:ref:`configuration` for more information on publishing hidden data.
32+
33+
Metadata publishing
34+
-------------------
35+
36+
Metadata providers work in the same manner as data providers, with a focus on geospatial metadata (data about data).
37+
38+
.. toctree::
39+
:maxdepth: 2
40+
41+
ogcapi-records
42+
stac
43+
44+
.. seealso::
45+
:ref:`configuration` for more information on publishing hidden metadata.
46+
47+
Process publishing
48+
------------------
49+
50+
In addition to data publishing, pygeoapi also provides the capability to publish
51+
processes that can be executed via the OGC API - Processes standard.
52+
53+
.. toctree::
54+
:maxdepth: 3
55+
56+
ogcapi-processes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/source/data-publishing/ogcapi-processes.rst renamed to docs/source/publishing/ogcapi-processes.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,10 @@ The below configuration is an example of a process defined as part of a custom P
7979
my-process:
8080
type: process
8181
processor:
82-
name: HelloWorld
83-
# refer to a process in the standard PYTHONPATH
84-
# e.g. my_package/my_module/my_file.py (class MyProcess)
85-
# the MyProcess class must subclass from pygeoapi.process.base.BaseProcessor
86-
name: my_package.my_module.my_file.MyProcess
82+
# refer to a process in the standard PYTHONPATH
83+
# e.g. my_package/my_module/my_file.py (class MyProcess)
84+
# the MyProcess class must subclass from pygeoapi.process.base.BaseProcessor
85+
name: my_package.my_module.my_file.MyProcess
8786
8887
8988
See :ref:`example-custom-pygeoapi-processing-plugin` for full processing plugin examples.
File renamed without changes.

0 commit comments

Comments
 (0)