Merge pull request #518 from open-contracting/465-mexico-inai-docs

Update Mexico INAI docs, run updatedocs, fix honduras docs and include kingfisher_process.rst at the index tree
open-contracting · Oct 9, 2020 · 23448c9 · 23448c9
2 parents f6c7dcb + 16b35bd
commit 23448c9
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 8 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -40,6 +40,7 @@ The crawl's directory will contain ``.json`` and ``.fileinfo`` files. The JSON f
 
    local.rst
    scrapyd.rst
+   kingfisher_process.rst
    spiders.rst
    crawl-report-guide.rst
    writing-spiders.rst

diff --git a/docs/spiders.rst b/docs/spiders.rst
@@ -177,6 +177,9 @@ Dominican
 .. autoclass:: kingfisher_scrapy.spiders.dominican_republic.DominicanRepublic
    :no-members:
 
+.. autoclass:: kingfisher_scrapy.spiders.dominican_republic_api.DominicanRepublicPortal
+   :no-members:
+
 Ecuador
 -------
 
@@ -231,6 +234,12 @@ Kenya
 .. autoclass:: kingfisher_scrapy.spiders.kenya_makueni.KenyaMakueni
    :no-members:
 
+Kyrgyzstan
+----------
+
+.. autoclass:: kingfisher_scrapy.spiders.kyrgyzstan.Kyrgyzstan
+   :no-members:
+
 Malta
 -----
 
@@ -252,9 +261,6 @@ Mexico
 .. autoclass:: kingfisher_scrapy.spiders.mexico_inai_portal.MexicoINAIPortal
    :no-members:
 
-.. autoclass:: kingfisher_scrapy.spiders.mexico_jalisco.MexicoJalisco
-   :no-members:
-
 .. autoclass:: kingfisher_scrapy.spiders.mexico_nuevo_leon_records.MexicoNuevoLeonRecords
    :no-members:
 
@@ -285,9 +291,21 @@ Nepal
 .. autoclass:: kingfisher_scrapy.spiders.nepal_portal.NepalPortal
    :no-members:
 
+Nicaragua
+---------
+
+.. autoclass:: kingfisher_scrapy.spiders.nicaragua_solid_waste.NicaraguaSolidWaste
+   :no-members:
+
 Nigeria
 -------
 
+.. autoclass:: kingfisher_scrapy.spiders.nigeria_budeshi_records.NigeriaBudeshiRecords
+   :no-members:
+
+.. autoclass:: kingfisher_scrapy.spiders.nigeria_budeshi_releases.NigeriaBudeshiReleases
+   :no-members:
+
 .. autoclass:: kingfisher_scrapy.spiders.nigeria_portal.NigeriaPortal
    :no-members:
 
@@ -315,6 +333,12 @@ Portugal
 .. autoclass:: kingfisher_scrapy.spiders.portugal.Portugal
    :no-members:
 
+.. autoclass:: kingfisher_scrapy.spiders.portugal_records.PortugalRecords
+   :no-members:
+
+.. autoclass:: kingfisher_scrapy.spiders.portugal_releases.PortugalReleases
+   :no-members:
+
 Scotland
 --------
 
@@ -324,6 +348,12 @@ Scotland
 .. autoclass:: kingfisher_scrapy.spiders.scotland_public_contracts.ScotlandPublicContracts
    :no-members:
 
+Spain
+-----
+
+.. autoclass:: kingfisher_scrapy.spiders.spain_zaragoza.SpainZaragoza
+   :no-members:
+
 Uganda
 ------
 

diff --git a/kingfisher_scrapy/spiders/honduras_oncae.py b/kingfisher_scrapy/spiders/honduras_oncae.py
@@ -19,7 +19,7 @@ class HondurasONCAE(CompressedFileSpider):
         ``DDC`` for "Catálogo Electrónico" system.
       sample
         Downloads the first package listed on the downloads page for each system.
-        If ``system'' is also provided, a single package is downloaded from that system.
+        If ``system`` is also provided, a single package is downloaded from that system.
     """
     name = 'honduras_oncae'
     data_type = 'release_package'

diff --git a/kingfisher_scrapy/spiders/honduras_portal_bulk_files.py b/kingfisher_scrapy/spiders/honduras_portal_bulk_files.py
@@ -17,7 +17,7 @@ class HondurasPortalBulkFiles(SimpleSpider):
         ``sefin`` for "Secretaria de Finanzas de Honduras" publisher.
       sample
         Downloads the first package listed in http://www.contratacionesabiertas.gob.hn/api/v1/descargas/?format=json.
-        If ``publisher'' is also provided, a single package is downloaded from that publisher.
+        If ``publisher`` is also provided, a single package is downloaded from that publisher.
     """
     name = 'honduras_portal_bulk_files'
     data_type = 'release_package'

diff --git a/kingfisher_scrapy/spiders/honduras_portal_records.py b/kingfisher_scrapy/spiders/honduras_portal_records.py
@@ -14,7 +14,7 @@ class HondurasPortalRecords(HondurasPortalBase):
         ``sefin`` for "Secretaria de Finanzas de Honduras" publisher.
       sample
         Download only the first record package in the dataset.
-        If ``publisher'' is also provided, a single package is downloaded from that publisher.
+        If ``publisher`` is also provided, a single package is downloaded from that publisher.
     """
     name = 'honduras_portal_records'
     data_type = 'record_package'

diff --git a/kingfisher_scrapy/spiders/honduras_portal_releases.py b/kingfisher_scrapy/spiders/honduras_portal_releases.py
@@ -14,7 +14,7 @@ class HondurasPortalReleases(HondurasPortalBase):
         ``sefin`` for "Secretaria de Finanzas de Honduras" publisher.
       sample
         Download only the first release package in the dataset.
-        If ``publisher'' is also provided, a single package is downloaded from that publisher.
+        If ``publisher`` is also provided, a single package is downloaded from that publisher.
     """
     name = 'honduras_portal_releases'
     data_type = 'release_package'

diff --git a/kingfisher_scrapy/spiders/mexico_inai.py b/kingfisher_scrapy/spiders/mexico_inai.py
@@ -7,6 +7,13 @@
 
 
 class MexicoINAI(SimpleSpider):
+    """
+    Download a bulk release package with data of 2017
+
+    Bulk download documentation
+      https://datos.gob.mx/busca/dataset/contrataciones-abiertas-del-inai
+    """
+
     name = 'mexico_inai'
     data_type = 'release_package'
     encoding = 'utf-8-sig'

diff --git a/kingfisher_scrapy/spiders/mexico_inai_portal.py b/kingfisher_scrapy/spiders/mexico_inai_portal.py
@@ -6,10 +6,12 @@
 
 class MexicoINAIPortal(SimpleSpider):
     """
+    Download records from 2017 to 2019
+
     Spider arguments
       sample
         Downloads the records listed on the first page at
-        http://contratacionesabiertas.inai.org.mx/contratacionesabiertas/contratos/.
+        http://contratacionesabiertas.inai.org.mx/contratacionesabiertas/contratos/
     """
     name = 'mexico_inai_portal'
     data_type = 'record'