Fixing doc warnings.

cedadev · Mar 4, 2024 · 438016f · 438016f
1 parent 341ac68
commit 438016f
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 17 deletions.
diff --git a/docs/source/stac_generator/extraction_methods.rst b/docs/source/stac_generator/extraction_methods.rst
@@ -1,14 +1,4 @@
 
-**********
-Processors
-**********
-
-Processors take a uri and return a dictionary of extracted information. They
-can be chained, one after the other and the results are merged such that arrays
-are appended to and key:value pairs are overwritten by subsequent write operations.
-
-.. _extraction-methods:
-
 Extraction Methods
 ==================
 

diff --git a/docs/source/stac_generator/inputs.rst b/docs/source/stac_generator/inputs.rst
@@ -1,7 +1,5 @@
 Inputs
 ======
 
-.. automodule:: stac_generator.plugins.inputs
-
 .. automodule:: stac_generator.plugins.inputs
   :members:
diff --git a/docs/source/stac_generator/outputs.rst b/docs/source/stac_generator/outputs.rst
@@ -1,7 +1,5 @@
 Outputs
 =======
 
-.. automodule:: stac_generator.plugins.outputs
-
 .. automodule:: stac_generator.plugins.outputs
   :members:
diff --git a/docs/source/stac_generator/user_guide/orientation.rst b/docs/source/stac_generator/user_guide/orientation.rst
@@ -17,7 +17,7 @@ python entry points to allow you to write your own plugins.
 The STAC Generator package stores some :ref:`inputs <stac_generator/inputs:inputs>` which can be used to read from a range of different
 sources messages of STAC objects to genertate.
 The :ref:`item <stac_generator/generators:Item Generator>`, and :ref:`collection <stac_generator/generators:Collection Generator>`
-generators take these messages and extract the required facets to buil the relevant STAC object using a variety of :ref:`extraction methods <stac_generator/extraction_methods:extraction methods>`.
+generators take these messages and extract the required facets to buil the relevant STAC object using a variety of :ref:`extraction methods <stac_generator/extraction_methods:Extraction Methods>`.
 These generated objects can then be passed to a range of :ref:`outputs <stac_generator/outputs:outputs>`.
 
 The generators have two levels of configuration. Global configuration, passed at the command line on
@@ -30,7 +30,7 @@ describe the workflow for extracting facets and other metadata to build the item
 Background for recipes can be found `here <recipes/recipes:Recipes>`_
 and a guide for how to build, and test these files is :ref:`here <recipes/building_a_workflow:building an Recipe>`.
 
-The different available extraction methods which can construct these workflows are found :ref:`here <stac_generator/extraction_methods:extraction methods>`.
+The different available extraction methods which can construct these workflows are found :ref:`here <stac_generator/extraction_methods:Extraction Methods>`.
 
 The `CEDA repository containing these recipes <https://github.com/cedadev/stac-recipes>`_ can
 be used as an example. An example which includes extracting metadata from the NetCDF header is

diff --git a/stac_generator/plugins/inputs/__init__.py b/stac_generator/plugins/inputs/__init__.py
@@ -10,7 +10,7 @@
 
 .. warning::
     Blocking input plugins will prevent others from being run. They are run
-    sequentially. For example, with the `file system input`_ plugin, you
+    sequentially. For example, with the :ref:`file system input plugin <stac_generator/inputs:File System Input>`, you
     could configure several to scan multiple directories but the rabbit plugin
     creates a listening connection which would block any other inputs.
 """