diff --git a/Makefile b/Makefile index 26e1d83e..7e408d2d 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: all clean format +.PHONY: all clean format docs deps .DEFAULT_GOAL: all MIX_ENV := $(MIX_ENV) @@ -51,6 +51,12 @@ format: deps: @for project in $(PROJECTS) ; do \ - echo Fetching deps: $$project ; \ + echo Fetching deps for $$project ; \ cd $$project && mix deps.get && cd .. ; \ done + +docs: + @for project in $(PROJECTS) ; do \ + echo Building docs for $$project ; \ + cd $$project && mix docs && cd .. ; \ + done diff --git a/docs/project/structure.md b/docs/project/structure.md index 8dc245f3..5b0cb9e6 100644 --- a/docs/project/structure.md +++ b/docs/project/structure.md @@ -9,6 +9,25 @@ The FarmBot OS application is broken into several sub OTP applications. * [farmbot_os](/docs/project/farmbot_os.md) * [farmbot_telemetry](/docs/project/farmbot_telemetry.md) +## Generating Specific documentation + +Each project has it's own inline documentation. Documentation can be +generated by changing directory into the application of interest and +using `exdoc` to generate docs. For example for `farmbot_core`: + +```bash +cd farmbot_core +mix deps.get +mix docs +``` + +Generating docs for all projects can be done with the root level Makefile: + +```bash +make deps +make docs +``` + ## Commonality All of these folders share a common structure. diff --git a/farmbot_celery_script/mix.exs b/farmbot_celery_script/mix.exs index abfb133b..16636003 100644 --- a/farmbot_celery_script/mix.exs +++ b/farmbot_celery_script/mix.exs @@ -28,6 +28,12 @@ defmodule FarmbotCeleryScript.MixProject do "coveralls.detail": :test, "coveralls.post": :test, "coveralls.html": :test + ], + source_url: "https://github.com/Farmbot/farmbot_os", + homepage_url: "http://farmbot.io", + docs: [ + logo: "../farmbot_os/priv/static/farmbot_logo.png", + extras: Path.wildcard("../docs/**/*.md") ] ] end diff --git a/farmbot_celery_script/mix.lock b/farmbot_celery_script/mix.lock index 013241ea..f4ac3504 100644 --- a/farmbot_celery_script/mix.lock +++ b/farmbot_celery_script/mix.lock @@ -16,7 +16,7 @@ "nimble_parsec": {:hex, :nimble_parsec, "0.5.3", "def21c10a9ed70ce22754fdeea0810dafd53c2db3219a0cd54cf5526377af1c6", [:mix], [], "hexpm"}, "parse_trans": {:hex, :parse_trans, "3.3.0", "09765507a3c7590a784615cfd421d101aec25098d50b89d7aa1d66646bc571c1", [:rebar3], [], "hexpm"}, "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.5", "6eaf7ad16cb568bb01753dbbd7a95ff8b91c7979482b95f38443fe2c8852a79b", [:make, :mix, :rebar3], [], "hexpm"}, - "telemetry": {:hex, :telemetry, "0.4.0", "8339bee3fa8b91cb84d14c2935f8ecf399ccd87301ad6da6b71c09553834b2ab", [:rebar3], [], "hexpm"}, + "telemetry": {:hex, :telemetry, "0.4.1", "ae2718484892448a24470e6aa341bc847c3277bfb8d4e9289f7474d752c09c7f", [:rebar3], [], "hexpm"}, "timex": {:hex, :timex, "3.6.1", "efdf56d0e67a6b956cc57774353b0329c8ab7726766a11547e529357ffdc1d56", [:mix], [{:combine, "~> 0.10", [hex: :combine, repo: "hexpm", optional: false]}, {:gettext, "~> 0.10", [hex: :gettext, repo: "hexpm", optional: false]}, {:tzdata, "~> 0.1.8 or ~> 0.5 or ~> 1.0.0", [hex: :tzdata, repo: "hexpm", optional: false]}], "hexpm"}, "tzdata": {:hex, :tzdata, "1.0.2", "6c4242c93332b8590a7979eaf5e11e77d971e579805c44931207e32aa6ad3db1", [:mix], [{:hackney, "~> 1.0", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm"}, "unicode_util_compat": {:hex, :unicode_util_compat, "0.4.1", "d869e4c68901dd9531385bb0c8c40444ebf624e60b6962d95952775cac5e90cd", [:rebar3], [], "hexpm"}, diff --git a/farmbot_core/mix.exs b/farmbot_core/mix.exs index b4666dd6..b261db01 100644 --- a/farmbot_core/mix.exs +++ b/farmbot_core/mix.exs @@ -40,7 +40,11 @@ defmodule FarmbotCore.MixProject do "coveralls.html": :test ], source_url: "https://github.com/Farmbot/farmbot_os", - homepage_url: "http://farmbot.io" + homepage_url: "http://farmbot.io", + docs: [ + logo: "../farmbot_os/priv/static/farmbot_logo.png", + extras: Path.wildcard("../docs/**/*.md") + ] ] end diff --git a/farmbot_core/mix.lock b/farmbot_core/mix.lock index 81da8a06..779400aa 100644 --- a/farmbot_core/mix.lock +++ b/farmbot_core/mix.lock @@ -1,6 +1,6 @@ %{ "certifi": {:hex, :certifi, "2.5.1", "867ce347f7c7d78563450a18a6a28a8090331e77fa02380b4a21962a65d36ee5", [:rebar3], [{:parse_trans, "~>3.3", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm"}, - "circuits_uart": {:hex, :circuits_uart, "1.3.0", "a489e648f358fb3c59e8dd146ead4295cec09d8abae3a0024be2fe3a0b6ddf8b", [:mix], [{:elixir_make, "~> 0.4", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm"}, + "circuits_uart": {:hex, :circuits_uart, "1.4.0", "799abad2d5f355bd571c46de089e62c6341e6b08f9fdf51f4d53d50f5d5bbda9", [:mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm"}, "combine": {:hex, :combine, "0.10.0", "eff8224eeb56498a2af13011d142c5e7997a80c8f5b97c499f84c841032e429f", [:mix], [], "hexpm"}, "connection": {:hex, :connection, "1.0.4", "a1cae72211f0eef17705aaededacac3eb30e6625b04a6117c1b2db6ace7d5976", [:mix], [], "hexpm"}, "cowboy": {:hex, :cowboy, "2.5.0", "4ef3ae066ee10fe01ea3272edc8f024347a0d3eb95f6fbb9aed556dacbfc1337", [:rebar3], [{:cowlib, "~> 2.6.0", [hex: :cowlib, repo: "hexpm", optional: false]}, {:ranch, "~> 1.6.2", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm"}, @@ -39,7 +39,7 @@ "sqlite_ecto2": {:hex, :sqlite_ecto2, "2.3.1", "fe58926854c3962c4c8710bd1070dd4ba3717ba77250387794cb7a65f77006aa", [:mix], [{:connection, "~> 1.0", [hex: :connection, repo: "hexpm", optional: false]}, {:db_connection, "~> 1.1", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "2.2.9", [hex: :ecto, repo: "hexpm", optional: false]}, {:poison, "~> 2.2 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.13", [hex: :postgrex, repo: "hexpm", optional: true]}, {:sbroker, "~> 1.0", [hex: :sbroker, repo: "hexpm", optional: false]}, {:sqlitex, "~> 1.4", [hex: :sqlitex, repo: "hexpm", optional: false]}], "hexpm"}, "sqlitex": {:hex, :sqlitex, "1.4.3", "a50f12d6aeb25f4ebb128453386c09bbba8f5abd3c7713dc5eaa92f359926ac5", [:mix], [{:decimal, "~> 1.5", [hex: :decimal, repo: "hexpm", optional: false]}, {:esqlite, "~> 0.2.4", [hex: :esqlite, repo: "hexpm", optional: false]}], "hexpm"}, "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.5", "6eaf7ad16cb568bb01753dbbd7a95ff8b91c7979482b95f38443fe2c8852a79b", [:make, :mix, :rebar3], [], "hexpm"}, - "telemetry": {:hex, :telemetry, "0.4.0", "8339bee3fa8b91cb84d14c2935f8ecf399ccd87301ad6da6b71c09553834b2ab", [:rebar3], [], "hexpm"}, + "telemetry": {:hex, :telemetry, "0.4.1", "ae2718484892448a24470e6aa341bc847c3277bfb8d4e9289f7474d752c09c7f", [:rebar3], [], "hexpm"}, "timex": {:hex, :timex, "3.6.1", "efdf56d0e67a6b956cc57774353b0329c8ab7726766a11547e529357ffdc1d56", [:mix], [{:combine, "~> 0.10", [hex: :combine, repo: "hexpm", optional: false]}, {:gettext, "~> 0.10", [hex: :gettext, repo: "hexpm", optional: false]}, {:tzdata, "~> 0.1.8 or ~> 0.5 or ~> 1.0.0", [hex: :tzdata, repo: "hexpm", optional: false]}], "hexpm"}, "tzdata": {:hex, :tzdata, "1.0.2", "6c4242c93332b8590a7979eaf5e11e77d971e579805c44931207e32aa6ad3db1", [:mix], [{:hackney, "~> 1.0", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm"}, "unicode_util_compat": {:hex, :unicode_util_compat, "0.4.1", "d869e4c68901dd9531385bb0c8c40444ebf624e60b6962d95952775cac5e90cd", [:rebar3], [], "hexpm"}, diff --git a/farmbot_ext/mix.exs b/farmbot_ext/mix.exs index e2546230..be69d828 100644 --- a/farmbot_ext/mix.exs +++ b/farmbot_ext/mix.exs @@ -11,6 +11,7 @@ defmodule FarmbotExt.MixProject do elixirc_options: [warnings_as_errors: true, ignore_module_conflict: true], start_permanent: Mix.env() == :prod, elixirc_paths: ["lib", "vendor"], + deps: deps(), test_coverage: [tool: ExCoveralls], preferred_cli_env: [ coveralls: :test, @@ -18,7 +19,12 @@ defmodule FarmbotExt.MixProject do "coveralls.post": :test, "coveralls.html": :test ], - deps: deps() + source_url: "https://github.com/Farmbot/farmbot_os", + homepage_url: "http://farmbot.io", + docs: [ + logo: "../farmbot_os/priv/static/farmbot_logo.png", + extras: Path.wildcard("../docs/**/*.md") + ] ] end diff --git a/farmbot_ext/mix.lock b/farmbot_ext/mix.lock index 981ec9fe..2456fba9 100644 --- a/farmbot_ext/mix.lock +++ b/farmbot_ext/mix.lock @@ -2,7 +2,7 @@ "amqp": {:hex, :amqp, "1.4.0", "4172595d467b9360850a8eca254c5946af9970684d335d555a9f3410a0e43995", [:mix], [{:amqp_client, "~> 3.8.0", [hex: :amqp_client, repo: "hexpm", optional: false]}], "hexpm"}, "amqp_client": {:hex, :amqp_client, "3.8.2", "b50ac381c3c016a697d6ab8f08367043a08358cfeb8ee97832ccc7d101e59cef", [:make, :rebar3], [{:rabbit_common, "3.8.2", [hex: :rabbit_common, repo: "hexpm", optional: false]}], "hexpm"}, "certifi": {:hex, :certifi, "2.5.1", "867ce347f7c7d78563450a18a6a28a8090331e77fa02380b4a21962a65d36ee5", [:rebar3], [{:parse_trans, "~>3.3", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm"}, - "circuits_uart": {:hex, :circuits_uart, "1.3.1", "8c0a56f06828133a0b08363ecb994350a9529d388a912357d31829ae617cd801", [:mix], [{:elixir_make, "~> 0.4", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm"}, + "circuits_uart": {:hex, :circuits_uart, "1.4.0", "799abad2d5f355bd571c46de089e62c6341e6b08f9fdf51f4d53d50f5d5bbda9", [:mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm"}, "combine": {:hex, :combine, "0.10.0", "eff8224eeb56498a2af13011d142c5e7997a80c8f5b97c499f84c841032e429f", [:mix], [], "hexpm"}, "connection": {:hex, :connection, "1.0.4", "a1cae72211f0eef17705aaededacac3eb30e6625b04a6117c1b2db6ace7d5976", [:mix], [], "hexpm"}, "credentials_obfuscation": {:hex, :credentials_obfuscation, "1.1.0", "513793cc20c18afc9e03e584b436192a751a8344890e03a8741c65c8d6866fab", [:rebar3], [], "hexpm"}, @@ -40,7 +40,7 @@ "sqlite_ecto2": {:hex, :sqlite_ecto2, "2.3.1", "fe58926854c3962c4c8710bd1070dd4ba3717ba77250387794cb7a65f77006aa", [:mix], [{:connection, "~> 1.0", [hex: :connection, repo: "hexpm", optional: false]}, {:db_connection, "~> 1.1", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "2.2.9", [hex: :ecto, repo: "hexpm", optional: false]}, {:poison, "~> 2.2 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.13", [hex: :postgrex, repo: "hexpm", optional: true]}, {:sbroker, "~> 1.0", [hex: :sbroker, repo: "hexpm", optional: false]}, {:sqlitex, "~> 1.4", [hex: :sqlitex, repo: "hexpm", optional: false]}], "hexpm"}, "sqlitex": {:hex, :sqlitex, "1.5.1", "0242c9a7602180b4f974315e6776c48d4ba211e9f4c5774dc886f15dc1a2edb3", [:mix], [{:decimal, "~> 1.7", [hex: :decimal, repo: "hexpm", optional: false]}, {:esqlite, "~> 0.3.0", [hex: :esqlite, repo: "hexpm", optional: false]}], "hexpm"}, "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.5", "6eaf7ad16cb568bb01753dbbd7a95ff8b91c7979482b95f38443fe2c8852a79b", [:make, :mix, :rebar3], [], "hexpm"}, - "telemetry": {:hex, :telemetry, "0.4.0", "8339bee3fa8b91cb84d14c2935f8ecf399ccd87301ad6da6b71c09553834b2ab", [:rebar3], [], "hexpm"}, + "telemetry": {:hex, :telemetry, "0.4.1", "ae2718484892448a24470e6aa341bc847c3277bfb8d4e9289f7474d752c09c7f", [:rebar3], [], "hexpm"}, "tesla": {:hex, :tesla, "1.3.0", "f35d72f029e608f9cdc6f6d6fcc7c66cf6d6512a70cfef9206b21b8bd0203a30", [:mix], [{:castore, "~> 0.1", [hex: :castore, repo: "hexpm", optional: true]}, {:exjsx, ">= 3.0.0", [hex: :exjsx, repo: "hexpm", optional: true]}, {:fuse, "~> 2.4", [hex: :fuse, repo: "hexpm", optional: true]}, {:gun, "~> 1.3", [hex: :gun, repo: "hexpm", optional: true]}, {:hackney, "~> 1.6", [hex: :hackney, repo: "hexpm", optional: true]}, {:ibrowse, "~> 4.4.0", [hex: :ibrowse, repo: "hexpm", optional: true]}, {:jason, ">= 1.0.0", [hex: :jason, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 0.4", [hex: :mint, repo: "hexpm", optional: true]}, {:poison, ">= 1.0.0", [hex: :poison, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.3", [hex: :telemetry, repo: "hexpm", optional: true]}], "hexpm"}, "timex": {:hex, :timex, "3.5.0", "b0a23167da02d0fe4f1a4e104d1f929a00d348502b52432c05de875d0b9cffa5", [:mix], [{:combine, "~> 0.10", [hex: :combine, repo: "hexpm", optional: false]}, {:gettext, "~> 0.10", [hex: :gettext, repo: "hexpm", optional: false]}, {:tzdata, "~> 0.1.8 or ~> 0.5", [hex: :tzdata, repo: "hexpm", optional: false]}], "hexpm"}, "tzdata": {:hex, :tzdata, "0.5.20", "304b9e98a02840fb32a43ec111ffbe517863c8566eb04a061f1c4dbb90b4d84c", [:mix], [{:hackney, "~> 1.0", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm"}, diff --git a/farmbot_firmware/lib/farmbot_firmware.ex b/farmbot_firmware/lib/farmbot_firmware.ex index f4e487eb..421a5566 100644 --- a/farmbot_firmware/lib/farmbot_firmware.ex +++ b/farmbot_firmware/lib/farmbot_firmware.ex @@ -158,7 +158,7 @@ defmodule FarmbotFirmware do * `{:report_success, []}` -> `:ok` * `{:report_invalid, []}` -> `{:error, :invalid_command}` * `{:report_error, []}` -> `{:error, :firmware_error}` - * `{:report_emergency_lock, []}` -> {:error, :emergency_lock}` + * `{:report_emergency_lock, []}` -> `{:error, :emergency_lock}` If the firmware is in any of the following states: * `:boot` diff --git a/farmbot_firmware/mix.exs b/farmbot_firmware/mix.exs index b5cd7cfd..2b5ec863 100644 --- a/farmbot_firmware/mix.exs +++ b/farmbot_firmware/mix.exs @@ -19,6 +19,7 @@ defmodule FarmbotFirmware.MixProject do elixirc_options: [warnings_as_errors: true, ignore_module_conflict: true], arduino_commit: arduino_commit(), start_permanent: Mix.env() == :prod, + deps: deps(), test_coverage: [tool: ExCoveralls], preferred_cli_env: [ test: :test, @@ -28,7 +29,12 @@ defmodule FarmbotFirmware.MixProject do "coveralls.post": :test, "coveralls.html": :test ], - deps: deps() + source_url: "https://github.com/Farmbot/farmbot_os", + homepage_url: "http://farmbot.io", + docs: [ + logo: "../farmbot_os/priv/static/farmbot_logo.png", + extras: Path.wildcard("../docs/**/*.md") + ] ] end diff --git a/farmbot_firmware/mix.lock b/farmbot_firmware/mix.lock index 39008a2d..9de4f48c 100644 --- a/farmbot_firmware/mix.lock +++ b/farmbot_firmware/mix.lock @@ -37,7 +37,7 @@ "sqlite_ecto2": {:hex, :sqlite_ecto2, "2.3.1", "fe58926854c3962c4c8710bd1070dd4ba3717ba77250387794cb7a65f77006aa", [:mix], [{:connection, "~> 1.0", [hex: :connection, repo: "hexpm", optional: false]}, {:db_connection, "~> 1.1", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "2.2.9", [hex: :ecto, repo: "hexpm", optional: false]}, {:poison, "~> 2.2 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.13", [hex: :postgrex, repo: "hexpm", optional: true]}, {:sbroker, "~> 1.0", [hex: :sbroker, repo: "hexpm", optional: false]}, {:sqlitex, "~> 1.4", [hex: :sqlitex, repo: "hexpm", optional: false]}], "hexpm"}, "sqlitex": {:hex, :sqlitex, "1.4.3", "a50f12d6aeb25f4ebb128453386c09bbba8f5abd3c7713dc5eaa92f359926ac5", [:mix], [{:decimal, "~> 1.5", [hex: :decimal, repo: "hexpm", optional: false]}, {:esqlite, "~> 0.2.4", [hex: :esqlite, repo: "hexpm", optional: false]}], "hexpm"}, "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.4", "f0eafff810d2041e93f915ef59899c923f4568f4585904d010387ed74988e77b", [:make, :mix, :rebar3], [], "hexpm"}, - "telemetry": {:hex, :telemetry, "0.4.0", "8339bee3fa8b91cb84d14c2935f8ecf399ccd87301ad6da6b71c09553834b2ab", [:rebar3], [], "hexpm"}, + "telemetry": {:hex, :telemetry, "0.4.1", "ae2718484892448a24470e6aa341bc847c3277bfb8d4e9289f7474d752c09c7f", [:rebar3], [], "hexpm"}, "timex": {:hex, :timex, "3.4.2", "d74649c93ad0e12ce5b17cf5e11fbd1fb1b24a3d114643e86dba194b64439547", [:mix], [{:combine, "~> 0.10", [hex: :combine, repo: "hexpm", optional: false]}, {:gettext, "~> 0.10", [hex: :gettext, repo: "hexpm", optional: false]}, {:tzdata, "~> 0.1.8 or ~> 0.5", [hex: :tzdata, repo: "hexpm", optional: false]}], "hexpm"}, "tzdata": {:hex, :tzdata, "0.5.19", "7962a3997bf06303b7d1772988ede22260f3dae1bf897408ebdac2b4435f4e6a", [:mix], [{:hackney, "~> 1.0", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm"}, "unicode_util_compat": {:hex, :unicode_util_compat, "0.4.1", "d869e4c68901dd9531385bb0c8c40444ebf624e60b6962d95952775cac5e90cd", [:rebar3], [], "hexpm"}, diff --git a/farmbot_os/lib/farmbot_os/lua.ex b/farmbot_os/lib/farmbot_os/lua.ex index efe22431..ce13d616 100644 --- a/farmbot_os/lib/farmbot_os/lua.ex +++ b/farmbot_os/lib/farmbot_os/lua.ex @@ -15,7 +15,7 @@ defmodule FarmbotOS.Lua do } # this function is used by SysCalls, but isn't a direct requirement. - @doc false + @doc "Logs an assertion based on it's result" def log_assertion(passed?, type, message) do meta = [assertion_passed: passed?, assertion_type: type] FarmbotCore.Logger.dispatch_log(__ENV__, :assertion, 2, message, meta) diff --git a/farmbot_os/lib/farmbot_os/sys_calls.ex b/farmbot_os/lib/farmbot_os/sys_calls.ex index 5be1821e..3874ac1e 100644 --- a/farmbot_os/lib/farmbot_os/sys_calls.ex +++ b/farmbot_os/lib/farmbot_os/sys_calls.ex @@ -69,6 +69,7 @@ defmodule FarmbotOS.SysCalls do @impl true defdelegate eval_assertion(comment, expression), to: Lua + defdelegate log_assertion(passed?, type, message), to: Lua @impl true diff --git a/farmbot_os/mix.exs b/farmbot_os/mix.exs index f312c1c5..f84e32ec 100644 --- a/farmbot_os/mix.exs +++ b/farmbot_os/mix.exs @@ -28,6 +28,7 @@ defmodule FarmbotOS.MixProject do elixirc_paths: elixirc_paths(Mix.env(), Mix.target()), deps_path: "deps/#{Mix.target()}", build_path: "_build/#{Mix.target()}", + deps: deps(), test_coverage: [tool: ExCoveralls], preferred_cli_target: [run: :host, test: :host], preferred_cli_env: [ @@ -36,7 +37,12 @@ defmodule FarmbotOS.MixProject do "coveralls.post": :test, "coveralls.html": :test ], - deps: deps() + source_url: "https://github.com/Farmbot/farmbot_os", + homepage_url: "http://farmbot.io", + docs: [ + logo: "../farmbot_os/priv/static/farmbot_logo.png", + extras: Path.wildcard("../docs/**/*.md") + ] ] end diff --git a/farmbot_telemetry/mix.exs b/farmbot_telemetry/mix.exs index 5b5dfccf..2c38e1e6 100644 --- a/farmbot_telemetry/mix.exs +++ b/farmbot_telemetry/mix.exs @@ -12,6 +12,7 @@ defmodule FarmbotTelemetry.MixProject do version: "0.1.0", elixir: "~> 1.9", start_permanent: Mix.env() == :prod, + deps: deps(), preferred_cli_env: [ test: :test, coveralls: :test, @@ -20,7 +21,12 @@ defmodule FarmbotTelemetry.MixProject do "coveralls.post": :test, "coveralls.html": :test ], - deps: deps() + source_url: "https://github.com/Farmbot/farmbot_os", + homepage_url: "http://farmbot.io", + docs: [ + logo: "../farmbot_os/priv/static/farmbot_logo.png", + extras: Path.wildcard("../docs/**/*.md") + ] ] end