From cf7ce949f9bb968050318cbf1f6ae9ec8d0c782d Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 1 Feb 2024 19:55:47 +0400 Subject: [PATCH 1/2] Release notes for 0.6.1. --- CHANGES.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index 7cf79a8..75abe20 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,6 +1,12 @@ Changes ======= +0.6.1 (YYYY-MM-DD) +------------------ + +* Improved the :attr:`zyte_spider_templates.spiders.base.BaseSpiderParams.url` + description. + 0.6.0 (2024-01-31) ------------------ From 0f74ee8143e95fa2d8d85bd2f498bef7f5e83df4 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 1 Feb 2024 19:55:58 +0400 Subject: [PATCH 2/2] Add the API reference page. --- docs/index.rst | 1 + docs/reference/index.rst | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 docs/reference/index.rst diff --git a/docs/index.rst b/docs/index.rst index f6394e2..d344faa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,4 +31,5 @@ zyte-spider-templates documentation :caption: All the rest :hidden: + reference/index changes diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 0000000..4fbf2c7 --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,35 @@ +========= +Reference +========= + +Base classes +============ + +.. autopydantic_model:: zyte_spider_templates.spiders.base.BaseSpiderParams + :inherited-members: BaseModel + +.. autoclass:: zyte_spider_templates.spiders.base.BaseSpider + +.. autoenum:: zyte_spider_templates.spiders.base.Geolocation + :noindex: + +E-commerce +========== + +.. autopydantic_model:: zyte_spider_templates.spiders.ecommerce.EcommerceSpiderParams + :noindex: + :inherited-members: BaseModel + +.. autoenum:: zyte_spider_templates.spiders.ecommerce.EcommerceCrawlStrategy + :noindex: + +.. autoclass:: zyte_spider_templates.spiders.ecommerce.ExtractFrom + :noindex: + +.. autoclass:: zyte_spider_templates.spiders.ecommerce.EcommerceSpider + :noindex: + +Pages +===== + +.. autoclass:: zyte_spider_templates.pages.HeuristicsProductNavigationPage