Skip to content

Commit

Permalink
Misc doc changes
Browse files Browse the repository at this point in the history
Besides other changes, this commit ensures the generated HTML doc for
HexDocs.pm will become the main source doc for this Elixir library which
leverage on ExDoc features.

List of changes:
* Set and use latest ex_doc
* Set readme as main html page
* Add changelog to html doc
* Fix markdowns
* Update gitignore
* Update formatter config
* Add license section
* Refactor project config
* Badges and more badges!
  • Loading branch information
kianmeng committed Mar 23, 2021
1 parent 736dbac commit 6089344
Show file tree
Hide file tree
Showing 32 changed files with 384 additions and 320 deletions.
8 changes: 2 additions & 6 deletions .formatter.exs
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
# Used by "mix format"
[
inputs: [
"config/**/*.{ex,exs}",
"lib/**/*.{ex,exs}",
"test/**/*.{ex,exs}",
"mix.exs"
]
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
]
33 changes: 28 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,36 @@
# 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").
exq-*.tar

# Temporary files for e.g. tests.
/tmp/

# Misc.
/ebin
priv/tmp_downloads/
/deps
/erl_crash.dump
/tmp
_build/
*.swp
*.log
.*.swp
*.swo
stdout
/doc
dump.rdb
6 changes: 2 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
### Added
- Queue adapter for mock testing @ananthakumaran and @samidarko

## [0.13.4] - 2019-11-3
## [0.13.4] - 2019-11-03

### Fixed
- Remove unnecessary serialization of enqueue calls #390 by @ananthakumaran and @sb8244
Expand Down Expand Up @@ -66,7 +66,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Configuration for Mix Format by @chulkilee.
- Use :microsecond vs :microseconds by @KalvinHom.

## Changed
### Changed
- Redis options are now passed in via `redis_options` by @ryansch and @ananthakumaran.
- Removed redix_sentinel dependency, now supported by new Redix version by @ananthakumaran.

Expand Down Expand Up @@ -112,5 +112,3 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
### Added
- Redis Sentinel support by @ananthakumaran.
- Make redis module name and start_link args configurable @ananthakumaran.


2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2014 Alex Kira
Copyright 2014 Alex Kira

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit 6089344

Please sign in to comment.