Improve the documentation

julien-duponchelle · julien-duponchelle · commit 07cf706139e3 · 2025-09-05T22:24:11.000+02:00
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -29,7 +29,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: html-docs
-          path: docs/build/html/
+          path: docs/_build/html/
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -6,10 +6,13 @@ API Reference
 Classes
 ----------------
 
-* :doc:`api/http_request`
-* :doc:`api/http_header`
-* :doc:`api/https_proxy_handler`
-* :doc:`api/tls_store`
+.. toctree::
+   :maxdepth: 1
+
+   http_request
+   http_header
+   https_proxy_handler
+   tls_store
 
 
 
diff --git a/docs/api/tls_store.rst b/docs/api/tls_store.rst
@@ -1,4 +1,4 @@
-TLS Store
+TLSStore
 ==========
 
 .. autoclass:: asyncio_https_proxy.TLSStore
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -219,4 +219,4 @@ Now that you have a working proxy, you can:
 - Build web scraping or testing tools
 - Create security analysis tools
 
-For more advanced usage, see the :doc:`api_reference`.
+For more advanced usage, see the :doc:`api/index`.
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,7 +15,7 @@ Table of Contents
 
    getting_started
    custom_ca
-   api_reference
+   api/index
    development
    faq
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-TLS Store`
	`1`	`+TLSStore`
`2`	`2`	`==========`
`3`	`3`
`4`	`4`	`.. autoclass:: asyncio_https_proxy.TLSStore`