remove various modules from docs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
diff --git a/README.md b/README.md
index a251c24..da82747 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,16 @@
# ExOvh
-ExOvh is an unofficial client library to make it easier to interact with both the [Ovh](https://api.ovh.com/) api
+ExOvh is an elixir library to make it easier to interact with both the [Ovh](https://api.ovh.com/) api
and the [Hubic](https://api.hubic.com/) api.
-## Note
+## Note
-This is an unofficial client to the OVH api and is not maintained by OVH.
+This repository is a work in progress.
-## Note
-This repository is a work in progress.
-## <<TODO>> Add Proper Readme
+## TODO list
- [ ] *Needed* - generate hex docs
@@ -22,13 +20,16 @@ This repository is a work in progress.
- [ ] *Needed* - *Tests* - verify the supervisor chain, genservers and genserver naming is working ok.
-- [ ] *Maybe* - add sensitive keys, secrets, etc to system env and allow the config.exs to get variables from `System`.
+- [ ] *Maybe* - investigate ways to add sensitive keys, secrets, etc to system env and allow the config.exs to get variables from `System`.
- [ ] *Maybe* - improve error handling for unexpected responses if possible - hard to find good documentation for expected error responses.
- [ ] *Maybe* - add a time to live configuration for the validity period of the ovh credential token
- [ ] *Maybe* - Add some further validations during the mix tasks.
- [ ] *Maybe* - Add request helper functions to create folders in the hubic api.
+## Note
+
+This is an unofficial client to the OVH api and is not maintained by OVH.
## Licence
diff --git a/lib/client.ex b/lib/client.ex
index 13417f9..9a00e48 100644
--- a/lib/client.ex
+++ b/lib/client.ex
@@ -31,10 +31,9 @@ defmodule ExOvh.Client do
which to authenticate requests.
For example, if hubic is set to :nil, then the hubic side of the supervision tree
will not be started. Then the only functions available will be:
+
TestOs.ExOvh.ovh_request/3
TestOs.ExOvh.ovh_prepare_request/3
-
-
"""
alias ExOvh.Defaults
diff --git a/lib/hubic/auth.ex b/lib/hubic/auth.ex
index 8053e00..aa1e570 100644
--- a/lib/hubic/auth.ex
+++ b/lib/hubic/auth.ex
@@ -1,5 +1,6 @@
defmodule ExOvh.Hubic.Auth do
- @moduledoc ~S"""
+ @moduledoc :false
+ @doc ~S"""
Houses the `prepare_request` function which delegates the function call to the appropriate
module & function depending on the `opts` key-values.
diff --git a/lib/hubic/request.ex b/lib/hubic/request.ex
index efedf48..260f9ea 100644
--- a/lib/hubic/request.ex
+++ b/lib/hubic/request.ex
@@ -1,5 +1,6 @@
defmodule ExOvh.Hubic.Request do
- @moduledoc ~S"""
+ @moduledoc :false
+ @doc ~S"""
Houses the `request` function which delegates the function call to the appropriate
module & function depending on the `opts` key-values.
diff --git a/lib/ovh/auth.ex b/lib/ovh/auth.ex
index abbb8ac..476ddd6 100644
--- a/lib/ovh/auth.ex
+++ b/lib/ovh/auth.ex
@@ -1,5 +1,6 @@
defmodule ExOvh.Ovh.Auth do
- @moduledoc ~s"""
+ @moduledoc :false
+ @doc ~s"""
Houses the `prepare_request` function which delegates the function call to the appropriate
module & function depending on the `opts` key-values.
diff --git a/lib/ovh/request.ex b/lib/ovh/request.ex
index 4a6e8d4..befb30a 100644
--- a/lib/ovh/request.ex
+++ b/lib/ovh/request.ex
@@ -1,5 +1,6 @@
defmodule ExOvh.Ovh.Request do
- @moduledoc ~S"""
+ @moduledoc :false
+ @doc ~S"""
Houses the `request` function which delegates the function call to the appropriate
module & function depending on the `opts` key-values.
diff --git a/lib/supervisor.ex b/lib/supervisor.ex
index 768b123..fac3268 100644
--- a/lib/supervisor.ex
+++ b/lib/supervisor.ex
@@ -1,5 +1,6 @@
defmodule ExOvh.Supervisor do
- @moduledoc ~S"""
+ @moduledoc :false
+ @doc ~S"""
Supervisor for the Hubic and Ovh api configuration.
"""
use Supervisor