(couchdb-meck) 05/05: Use ex_doc instead of edoc

[va...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

vatamane pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/couchdb-meck.git

commit 29360b25b708b2dc9d68a4f46f6a1b8b55f72518
Author: Adam Lindberg <he...@alind.io>
AuthorDate: Fri Dec 13 10:16:28 2024 +0100

    Use ex_doc instead of edoc
---
 .gitignore        |  5 +----
 doc/overview.edoc | 25 -------------------------
 rebar.config      | 10 ++++++++++
 3 files changed, 11 insertions(+), 29 deletions(-)

diff --git a/.gitignore b/.gitignore
index 770ef2e..c7b3e8a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,7 +17,4 @@ logs
 _build
 .idea
 rebar3.crashdump
-doc/*.html
-doc/edoc-info
-doc/erlang.png
-doc/stylesheet.css
+doc
diff --git a/doc/overview.edoc b/doc/overview.edoc
deleted file mode 100644
index f4624b4..0000000
--- a/doc/overview.edoc
+++ /dev/null
@@ -1,25 +0,0 @@
-%%==============================================================================
-%% Copyright 2010-2017 Adam Lindberg, 2010-2011 Erlang Solutions Ltd
-%%
-%% 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
-%%
-%% 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.
-%%==============================================================================
-
-@author Adam Lindberg <ep...@gmail.com>
-@copyright 2010-2017 Adam Lindberg, 2010-2011 Erlang Solutions Ltd
-@version 0.9.2
-@title meck, a Mocking Library for Erlang
-
-@doc
-
-== About ==
-meck is a mocking library for Erlang.
diff --git a/rebar.config b/rebar.config
index a013b14..381a791 100644
--- a/rebar.config
+++ b/rebar.config
@@ -1,5 +1,7 @@
 {minimum_otp_vsn, "25.0"}.
 
+{project_plugins, [rebar3_ex_doc]}.
+
 {profiles, [
     {test, [
         {deps, [unite]},
@@ -34,3 +36,11 @@
         error_handling
     ]}
 ]}.
+
+{hex, [{doc, ex_doc}]}.
+{ex_doc, [
+    {source_url, <<"https://github.com/eproxus/meck">>},
+    {extras, [<<"README.md">>, <<"LICENSE">>]},
+    {main, <<"readme">>},
+    {prefix_ref_vsn_with_v, false}
+]}.