Rename examples to usage in docs (#237)

* Fix headings markdown * Rename examples to "usage" * Also move usage.rst to root of docs
hvac · Jul 31, 2018 · 09e907b · 09e907b
1 parent eeae7b7
commit 09e907b
Show file tree

Hide file tree

Showing 11 changed files with 15 additions and 15 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ the latest `vault` binary is available in your `PATH`.
 
 ### Examples
 
-Example code or general guides for methods in this module can be added under [docs/examples](docs/examples). Any newly added or update method in this module will ideally have a corresponding addition to these examples.
+Example code or general guides for methods in this module can be added under [docs/usage](docs/usage). Any newly added or updated method in this module will ideally have a corresponding addition to these examples. New usage sections should also be added to the table of contents tracked in [docs/usage.rst](docs/usage.rst).
 
 ## Backwards Compatibility Breaking Changes
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,7 @@ Source code repository hosted at `github.com/hvac/hvac`_.
 
 
    Readme <readme>
-   Examples <examples/examples>
+   usage
    advanced_usage
    source/hvac
    contributing

diff --git a/docs/source/hvac.rst b/docs/source/hvac.rst
@@ -10,31 +10,31 @@ hvac.v1.Client
     :show-inheritance:
 
 hvac.utils
-----------------------
+----------
 
 .. automodule:: hvac.utils
     :members:
     :undoc-members:
     :show-inheritance:
 
 hvac.aws\_utils
-----------------------
+---------------
 
 .. automodule:: hvac.aws_utils
     :members:
     :undoc-members:
     :show-inheritance:
 
 hvac.adapters
-----------------------
+-------------
 
 .. automodule:: hvac.adapters
     :members:
     :undoc-members:
     :show-inheritance:
 
 hvac.exceptions
-----------------------
+---------------
 
 .. automodule:: hvac.exceptions
     :members:

diff --git a/docs/examples/examples.rst → docs/usage.rst b/docs/examples/examples.rst → docs/usage.rst
@@ -1,16 +1,16 @@
-Examples
-========
+Usage
+=====
 
 .. toctree::
    :maxdepth: 4
 
-   system_backend
-   token_auth_method
-   aws
-   gcp
-   kubernetes_auth_method
-   approle_auth_method
-   ldap_auth_method
+   usage/system_backend
+   usage/token_auth_method
+   usage/aws
+   usage/gcp
+   usage/kubernetes_auth_method
+   usage/approle_auth_method
+   usage/ldap_auth_method
 
 
 Authenticate to different auth backends

diff --git a/docs/examples/approle_auth_method.rst → docs/usage/approle_auth_method.rst b/docs/examples/approle_auth_method.rst → docs/usage/approle_auth_method.rst
diff --git a/docs/examples/aws.rst → docs/usage/aws.rst b/docs/examples/aws.rst → docs/usage/aws.rst
diff --git a/docs/examples/gcp.rst → docs/usage/gcp.rst b/docs/examples/gcp.rst → docs/usage/gcp.rst
diff --git a/docs/examples/kubernetes_auth_method.rst → docs/usage/kubernetes_auth_method.rst b/docs/examples/kubernetes_auth_method.rst → docs/usage/kubernetes_auth_method.rst
diff --git a/docs/examples/ldap_auth_method.rst → docs/usage/ldap_auth_method.rst b/docs/examples/ldap_auth_method.rst → docs/usage/ldap_auth_method.rst
diff --git a/docs/examples/system_backend.rst → docs/usage/system_backend.rst b/docs/examples/system_backend.rst → docs/usage/system_backend.rst
diff --git a/docs/examples/token_auth_method.rst → docs/usage/token_auth_method.rst b/docs/examples/token_auth_method.rst → docs/usage/token_auth_method.rst