Merge pull request #40 from driehle/documentation/sidebar

Add sidebar to documentation
doctrine · Oct 27, 2021 · 34af2d9 · 34af2d9
2 parents 603cce7 + 55e5967
commit 34af2d9
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ This library provides Doctrine hydrators for Laminas.
 Run the following to install this library using [Composer](https://getcomposer.org/):
 
 ```bash
-$ composer require doctrine/doctrine-laminas-hydrator
+composer require doctrine/doctrine-laminas-hydrator
 ```
 
 ## Documentation

diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -1,5 +1,5 @@
-Usage of doctrine-laminas-hydrator
-==================================
+Introduction
+============
 
 Hydrators insert an array of data into object properties (this is called
 "hydrating") and convert object properties back to an array (this is called

diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst
@@ -0,0 +1,9 @@
+.. toctree::
+    :depth: 3
+
+    index
+    basic-usage
+    collections-strategy
+    by-value-by-reference
+    laminas-form
+    performance-considerations