Merge pull request #33 from zytedata/relnotes-0.6.1

Release notes for 0.6.1
zytedata · Feb 2, 2024 · 817633b · 817633b
2 parents 14a6ffa + 0f74ee8
commit 817633b
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 0 deletions.
diff --git 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)
 ------------------
 

diff --git 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
@@ -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