From 77c2b15b5815fdb6e67226c30d8d3ed060a7a3ff Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Wed, 21 Oct 2020 16:30:15 -0400 Subject: [PATCH] updatedocs: Fix two-word country names, closes #527 --- docs/spiders.rst | 17 ++++++++--------- kingfisher_scrapy/commands/updatedocs.py | 7 +++++-- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/spiders.rst b/docs/spiders.rst index acc327b4..f6c1c4af 100644 --- a/docs/spiders.rst +++ b/docs/spiders.rst @@ -8,7 +8,6 @@ All the spiders have these common arguments: .. Do not edit this file. Instead, run: `scrapy updatedocs` - Afghanistan ----------- @@ -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 @@ -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 diff --git a/kingfisher_scrapy/commands/updatedocs.py b/kingfisher_scrapy/commands/updatedocs.py index 0fdea02b..195a25c0 100644 --- a/kingfisher_scrapy/commands/updatedocs.py +++ b/kingfisher_scrapy/commands/updatedocs.py @@ -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("""\ @@ -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):