- Bug fixes
- Include callbacks even if a module defines a struct
-
Enhancements
- From now on it's possible to set the title in the sidebar area for additional content, default: "Pages"
- Set the path and title of each additional page in
mix.exs
file - Use the first
h1
as menu title if title is not configured - Include the project name as part of the header in small devices
-
Bug fixes
- Increase the visual separation between functions
- Remove the
extra-
prefix for the additional documentation files - Extra large images do not create an overflow in the content
- Enhancements
- Many improvements and bug fixes in new layout
- Reduced build size
- Overview has been renamed to API Reference
- All extra content, including API Reference, has been moved to inside "Pages"
- Extra files are now downcased and prefixed by
extra-
-
Enhancements
- Whole new clean, readable, usable, responsive layout
- Support for adding logo to generated docs (must be 64x64 pixels)
- Support for adding extra pages to generated docs
- Improve formatting of typespecs and callbacks
-
Backwards incompatible changes
--readme
option and:readme
configuration have been removed. Use:extras
in yourmix.exs
file or pass--extra
/-e
in the command-line (may be given multiple times)
- Bug fixes
- Generate
README.html
file instead ofreadme.html
as in previous releases - Style fixes in the new layout
- Generate
- Bug fixes
- Style fixes in the new layout
-
Enhancements
- Uglify and minify JS and CSS code
- Performance improvements when building sidebar
- Redirect from index.html to proper page
-
Bug fixes
- Style fixes in the new layout
- Bug fixes
- Style fixes in the new layout
- Enhancements
- New and responsive layout without frames
- Bug fixes
- Update highlight.js with fixes some inlining issues
- Require latest Earmark
- Bug fixes
- Support Elixir master
- Fix error reporting when modules are compiled without docs
- Enhancements
- Use
type=search
for search input - Update highlight.js dependency
- Properly tag code comments as coming from Elixir/IEx unless noted otherwise
- Add support for hash redirection
- Use
- Enhancements
- Documentation is now generated at
doc
to follow OTP "standard"
- Documentation is now generated at
- Enhancements
- Improvements to the document structure
- Add syntax highlight
- Enhancements
- Autolink modules and functions in the README
- Generate ids for callbacks starting with "c:"
- Ensure group ordering is consistent: TYPES > FUNCTIONS > MACROS > CALLBACKS
- Allow users to search by Module.function
- Enhancements
- Support Elixir v1.0.0-rc1
- Bug fixes
- Use proper ANSI escape sequence on Mix success messages
- Enhancements
- Support Elixir v0.15.0
- Add support for Earmark - no need for external processors
- Enhancements
- First public release
- Support pandoc and devinus/markdown as markdown processors