docs: Move Splinter API into separate section (#1237)

cobrateam · Feb 14, 2024 · 1bfb537 · 1bfb537
1 parent d6f0c85
commit 1bfb537
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 37 deletions.
diff --git a/docs/api/browser.rst b/docs/api/browser.rst
@@ -0,0 +1,14 @@
+.. Copyright 2012 splinter authors. All rights reserved.
+   Use of this source code is governed by a BSD-style
+   license that can be found in the LICENSE file.
+
+.. meta::
+    :description: Splinter API documentation for DriverAPI and ElementAPI
+    :keywords: splinter, python, api documentation, api, driverapi, elementapi, driver creation
+
+Browser
+=======
+
+.. module:: splinter.browser
+
+.. autofunction:: Browser
diff --git a/docs/api/driver-and-element-api.rst b/docs/api/driver-and-element-api.rst
@@ -6,27 +6,16 @@
     :description: Splinter API documentation for DriverAPI and ElementAPI
     :keywords: splinter, python, api documentation, api, driverapi, elementapi, driver creation
 
-
-Browser
-=======
-
-.. module:: splinter.browser
-
-.. autofunction:: Browser
-
-
-
 .. module:: splinter.driver
 
 DriverAPI
 =========
 
-
 .. autoclass:: DriverAPI
    :members:
 
 ElementAPI
 ==========
 
 .. autoclass:: ElementAPI
-   :members:
+  :members:
diff --git a/docs/api/index.rst b/docs/api/index.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -42,7 +42,17 @@
   iframes-and-alerts
   http-status-code-and-exception
   http-proxies
-  api/index
+
+.. toctree::
+  :caption: Splinter API
+  :hidden:
+
+  api/browser
+  api/driver-and-element-api
+  api/cookie-manager
+  api/element-list
+  api/request-handling
+  api/exceptions
 
 
 .. toctree::

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -10,7 +10,7 @@
 Tutorial
 ++++++++
 
-Before starting, make sure Splinter is :doc:`installed </install>`
+Before starting, make sure Splinter is :doc:`installed <install/install>`
 
 This tutorial provides a simple example, teaching step by step how to:
 

diff --git a/docs/why.rst b/docs/why.rst
@@ -7,7 +7,7 @@ Splinter is used to write web browser automation scripts.
 
 The project has two primary goals:
 
-* Provide a :doc:`common, high-level API </api/index>` on top of existing
+* Provide a common, high-level API on top of existing
   browser automation tools such as `Selenium`_. The API is an abstraction layer
   that is human-friendly and designed for easy, efficient scripting.