Skip to content

Commit

Permalink
updatedocs: Fix two-word country names, closes #527
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Oct 21, 2020
1 parent ecdec62 commit 77c2b15
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
17 changes: 8 additions & 9 deletions docs/spiders.rst
Expand Up @@ -8,7 +8,6 @@ All the spiders have these common arguments:
.. Do not edit this file. Instead, run: `scrapy updatedocs`
Afghanistan
-----------

Expand Down Expand Up @@ -72,13 +71,13 @@ Colombia
.. autoclass:: kingfisher_scrapy.spiders.colombia_bulk.ColombiaBulk
:no-members:

Costarica
---------
Costa Rica
----------

.. autoclass:: kingfisher_scrapy.spiders.costarica_poder_judicial_records.CostaRicaPoderJudicialRecords
.. autoclass:: kingfisher_scrapy.spiders.costa_rica_poder_judicial_records.CostaRicaPoderJudicialRecords
:no-members:

.. autoclass:: kingfisher_scrapy.spiders.costarica_poder_judicial_releases.CostaRicaPoderJudicialReleases
.. autoclass:: kingfisher_scrapy.spiders.costa_rica_poder_judicial_releases.CostaRicaPoderJudicialReleases
:no-members:

Digiwhist
Expand Down Expand Up @@ -186,13 +185,13 @@ Digiwhist
.. autoclass:: kingfisher_scrapy.spiders.digiwhist_united_kingdom.DigiwhistUnitedKingdomRepublic
:no-members:

Dominicanrepublic
-----------------
Dominican Republic
------------------

.. autoclass:: kingfisher_scrapy.spiders.dominicanrepublic.DominicanRepublic
.. autoclass:: kingfisher_scrapy.spiders.dominican_republic.DominicanRepublic
:no-members:

.. autoclass:: kingfisher_scrapy.spiders.dominicanrepublic_api.DominicanRepublicPortal
.. autoclass:: kingfisher_scrapy.spiders.dominican_republic_api.DominicanRepublicPortal
:no-members:

Ecuador
Expand Down
7 changes: 5 additions & 2 deletions kingfisher_scrapy/commands/updatedocs.py
Expand Up @@ -15,7 +15,10 @@ def run(self, args, opts):
basedir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

def _keyfunc(module):
return module.__name__.rsplit('.', 1)[-1].split('_', 1)[0]
module_name = module.__name__.rsplit('.', 1)[-1]
if module_name.startswith(('costa_rica', 'dominican_republic')):
return '_'.join(module_name.split('_', 2)[:2])
return module_name.split('_', 1)[0]

with open(os.path.join(basedir, 'docs', 'spiders.rst'), 'w') as f:
f.write(dedent("""\
Expand All @@ -34,7 +37,7 @@ def _keyfunc(module):
if key in ('spiders', 'fail'):
continue

f.write('\n{}\n{}\n'.format(key.capitalize(), '-' * len(key)))
f.write('\n{}\n{}\n'.format(key.replace('_', ' ').title(), '-' * len(key)))

for module in group:
for cls in iter_spider_classes(module):
Expand Down

0 comments on commit 77c2b15

Please sign in to comment.