Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation improvements #146

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Documentation improvements #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.rebar
_build
ebin
doc
8 changes: 8 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,11 @@ clean:

dialyze:
@$(REBAR) dialyzer

edoc:
mkdir doc && cp -fR doc_src/* doc
$(REBAR) edoc

edoc_private:
mkdir doc && cp -fR doc_src/* doc
$(REBAR) as edoc_private edoc
6 changes: 6 additions & 0 deletions doc_src/overview.edoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
@author Devin Torres (devinus) <[email protected]>
@author Andrew Thompson (Vagabond) <[email protected]>
@author Kurt Williams (onkel-dirtus) <[email protected]>
@title poolboy
@doc A hunky Erlang worker pool factory. <br/>Poolboy is a lightweight, generic pooling library for Erlang with a focus on simplicity, performance, and rock-solid disaster recovery.
@copyright Poolboy is available in the public domain (see UNLICENSE). Poolboy is also optionally available under the ISC license (see LICENSE), meant especially for jurisdictions that do not recognize public domain works.
65 changes: 65 additions & 0 deletions doc_src/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/* standard EDoc style sheet */
body {
font-family: Verdana, Arial, Helvetica, sans-serif;
margin-left: .25in;
margin-right: .2in;
margin-top: 0.2in;
margin-bottom: 0.2in;
color: #000000;
background-color: #ffffff;
}
h1,h2 {
margin-left: -0.2in;
}
div.navbar {
background-color: #add8e6;
padding: 0.2em;
}
h2.indextitle {
padding: 0.4em;
background-color: #add8e6;
}
h3.function,h3.typedecl {
background-color: #add8e6;
padding-left: 1em;
}
div.spec {
margin-left: 2em;

background-color: #eeeeee;
}
a.module {
text-decoration:none
}
a.module:hover {
background-color: #eeeeee;
}
ul.definitions {
list-style-type: none;
}
ul.index {
list-style-type: none;
background-color: #eeeeee;
}

/*
* Minor style tweaks
*/
ul {
list-style-type: square;
}
table {
border-collapse: collapse;
}
td {
padding: 3px;
vertical-align: middle;
}

/*
Tune styles
*/

code, p>tt, a>tt {
font-size: 1.2em;
}
14 changes: 12 additions & 2 deletions rebar.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,15 @@
{plugins, [
{rebar3_eqc, ".*", {git, "https://github.com/kellymclaughlin/rebar3-eqc-plugin.git", {tag, "0.1.0"}}}
]}
]
}]}.
]},

{edoc_private, [
{edoc_opts, [
{private, true}
]}
]}
]}.

{edoc_opts, [
{preprocess, true}, {stylesheet, "style.css"}
]}.
Loading