From b1d7ee74e30d2af796bd6777ef9466a6c4bb4279 Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Tue, 20 Apr 2021 22:20:11 +0800 Subject: [PATCH] Misc doc changes Besides other documentation changes, this commit ensures the generated HTML doc for HexDocs.pm will become the main source doc for this Elixir library which leverage on latest ExDoc features. --- .formatter.exs | 6 ++---- .gitignore | 33 +++++++++++++++++++++++++++++---- CHANGELOG.md | 5 +++++ README.md | 21 +++++++++++++++++++-- mix.exs | 19 ++++++++++++------- mix.lock | 4 ++-- 6 files changed, 69 insertions(+), 19 deletions(-) diff --git a/.formatter.exs b/.formatter.exs index a49a299..d2cda26 100644 --- a/.formatter.exs +++ b/.formatter.exs @@ -1,6 +1,4 @@ +# Used by "mix format" [ - inputs: [ - "{lib,test}/**/*.{ex,exs}", - "{.formatter,mix}.exs" - ] + inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] ] diff --git a/.gitignore b/.gitignore index 543442f..d33a32f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,29 @@ -_build/ -deps/ -doc/ -plts/ +# The directory Mix will write compiled artifacts to. +/_build/ + +# If you run "mix test --cover", coverage assets end up here. +/cover/ + +# The directory Mix downloads your dependencies sources to. +/deps/ + +# Where third-party dependencies like ExDoc output generated docs. +/doc/ + +# Ignore .fetch files in case you like to edit your project deps locally. +/.fetch + +# If the VM crashes, it generates a dump, let's ignore it too. +erl_crash.dump + +# Also ignore archive artifacts (built via "mix archive.build"). +*.ez + +# Ignore package tarball (built via "mix hex.build"). +geolix-*.tar + +# Temporary files for e.g. tests. +/tmp/ + +# Dialyzer +/plts/ diff --git a/CHANGELOG.md b/CHANGELOG.md index b0d232d..ebdc9ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + ## v2.0.0 (2020-09-20) - Enhancements diff --git a/README.md b/README.md index 58045a8..ab88fe3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # Geolix +[![Test](https://github.com/elixir-geolix/geolix/actions/workflows/test.yml/badge.svg)](https://github.com/elixir-geolix/geolix/actions/workflows/test.yml) +[![Module Version](https://img.shields.io/hexpm/v/geolix.svg)](https://hex.pm/packages/geolix) +[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/geolix/) +[![Total Download](https://img.shields.io/hexpm/dt/geolix.svg)](https://hex.pm/packages/geolix) +[![License](https://img.shields.io/hexpm/l/geolix.svg)](https://github.com/elixir-geolix/geolix/blob/master/LICENSE) +[![Last Updated](https://img.shields.io/github/last-commit/elixir-geolix/geolix.svg)](https://github.com/elixir-geolix/geolix/commits/master) + IP information lookup provider. ## Package Setup @@ -95,6 +102,16 @@ iex(2)> Geolix.lookup({127, 0, 0, 1}, where: :my_database) Full documentation is available inline in the `Geolix` module and at [https://hexdocs.pm/geolix](https://hexdocs.pm/geolix). -## License +## Copyright and License + +Copyright (c) 2016 Marc Neudert + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) -[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/mix.exs b/mix.exs index 2512cd5..bbd2f12 100644 --- a/mix.exs +++ b/mix.exs @@ -10,7 +10,6 @@ defmodule Geolix.MixProject do version: "2.1.0-dev", elixir: "~> 1.7", deps: deps(), - description: "IP information lookup provider", dialyzer: dialyzer(), docs: docs(), package: package(), @@ -53,17 +52,23 @@ defmodule Geolix.MixProject do defp docs do [ - main: "Geolix", + extras: ["CHANGELOG.md", "README.md"], + main: "readme", source_ref: "master", - source_url: @url_github + source_url: @url_github, + formatters: ["html"] ] end defp package do - %{ + [ + description: "IP information lookup provider", files: ["CHANGELOG.md", "LICENSE", "mix.exs", "README.md", "lib"], - licenses: ["Apache 2.0"], - links: %{"GitHub" => @url_github} - } + licenses: ["Apache-2.0"], + links: %{ + "Changelog" => "https://hexdocs.pm/geolix/changelog.html", + "GitHub" => @url_github + } + ] end end diff --git a/mix.lock b/mix.lock index 083cba7..0b1bdbd 100644 --- a/mix.lock +++ b/mix.lock @@ -3,9 +3,9 @@ "certifi": {:hex, :certifi, "2.6.1", "dbab8e5e155a0763eea978c913ca280a6b544bfa115633fa20249c3d396d9493", [:rebar3], [], "hexpm", "524c97b4991b3849dd5c17a631223896272c6b0af446778ba4675a1dff53bb7e"}, "credo": {:hex, :credo, "1.5.5", "e8f422026f553bc3bebb81c8e8bf1932f498ca03339856c7fec63d3faac8424b", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2.8", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "dd8623ab7091956a855dc9f3062486add9c52d310dfd62748779c4315d8247de"}, "dialyxir": {:hex, :dialyxir, "1.1.0", "c5aab0d6e71e5522e77beff7ba9e08f8e02bad90dfbeffae60eaf0cb47e29488", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "07ea8e49c45f15264ebe6d5b93799d4dd56a44036cf42d0ad9c960bc266c0b9a"}, - "earmark_parser": {:hex, :earmark_parser, "1.4.12", "b245e875ec0a311a342320da0551da407d9d2b65d98f7a9597ae078615af3449", [:mix], [], "hexpm", "711e2cc4d64abb7d566d43f54b78f7dc129308a63bc103fbd88550d2174b3160"}, + "earmark_parser": {:hex, :earmark_parser, "1.4.13", "0c98163e7d04a15feb62000e1a891489feb29f3d10cb57d4f845c405852bbef8", [:mix], [], "hexpm", "d602c26af3a0af43d2f2645613f65841657ad6efc9f0e361c3b6c06b578214ba"}, "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"}, - "ex_doc": {:hex, :ex_doc, "0.24.1", "15673de99154f93ca7f05900e4e4155ced1ee0cd34e0caeee567900a616871a4", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "07972f17bdf7dc7b5bd76ec97b556b26178ed3f056e7ec9288eb7cea7f91cce2"}, + "ex_doc": {:hex, :ex_doc, "0.24.2", "e4c26603830c1a2286dae45f4412a4d1980e1e89dc779fcd0181ed1d5a05c8d9", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "e134e1d9e821b8d9e4244687fb2ace58d479b67b282de5158333b0d57c6fb7da"}, "excoveralls": {:hex, :excoveralls, "0.14.0", "4b562d2acd87def01a3d1621e40037fdbf99f495ed3a8570dfcf1ab24e15f76d", [:mix], [{:hackney, "~> 1.16", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "94f17478b0cca020bcd85ce7eafea82d2856f7ed022be777734a2f864d36091a"}, "file_system": {:hex, :file_system, "0.2.10", "fb082005a9cd1711c05b5248710f8826b02d7d1784e7c3451f9c1231d4fc162d", [:mix], [], "hexpm", "41195edbfb562a593726eda3b3e8b103a309b733ad25f3d642ba49696bf715dc"}, "hackney": {:hex, :hackney, "1.17.4", "99da4674592504d3fb0cfef0db84c3ba02b4508bae2dff8c0108baa0d6e0977c", [:rebar3], [{:certifi, "~>2.6.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~>6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~>1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.3.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~>1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "de16ff4996556c8548d512f4dbe22dd58a587bf3332e7fd362430a7ef3986b16"},