v1.0.0

Breaking changes

• Elm 0.18.0 is no longer supported.
• Requires rsync.
• Takes --elm-path instead of --elm-make. If elm executable is found in the $PATH, it will be used; Elm will not be installed automatically.
• Takes --exclude-modules instead of --exclude.
• Takes a new & required flag --fake-license that controls which license to specify when running elm make; this is needed because Elm only generates docs for packages and elm.json for packages requires a license field.

New / updates

• Supports Elm 0.19.0/0.19.1 (Thanks for the bug reports and fixes).
• Frontend code is based on the latest version (6e00489) of package.elm-lang.org.
• New flag: --build-dir=<project_path>/.elm-doc/ to control the temporary build directory.
• New flag: --exclude-source-directories to exclude specific source-directories from the build/validation target.
• New flags: --fake-user, --fake-project, --fake-version, --fake-summary to populate the elm.json file when running elm make; Elm only generates docs for packages and elm.json for packages takes these fields in addition to elm.json for applications.

Internal / dev updates

• Project now uses poetry.
• nix-shell tracks dev dependencies and is used in CI.
• CI moved from Travis to GitHub Actions.

v1.0.0b4

Breaking changes

• Indirect deps are no longer included in the generated docs
• Elm is no longer installed and used automatically when no --elm-path is specified

Fixes

• Fixes ambiguous import error when a project's direct and indirect deps share the same module name (#55)
• Invoke rsync with --ignore-errors to power through errors like "IO error encountered -- skipping file deletion" which is silently dropped by rsync

New

• Support -h as a flag for displaying help
• Run Travis tests against Python 3.7

v1.0.0b3

Breaking change:

• The rsync command is now required to run elm-doc in order to support multiple source directories cleanly.

Note: I'm sorry I seem to have lost the commit that bumps the version number in setup.py. If it's causing problems, let me know and I'll try to figure it out.

v1.0.0b1

Since this version includes significant code change in order to rewrite port declarations as part of the build, I'm marking this as a pre-release. While it has been tested against a fairly large codebase of Elm, there may be edge cases that elm-doc can't handle.

Backwards incompatible changes

• Drop Python 3.4 support
• Drop Elm 0.18 support
• Require --fake-license flag to be specified when invoking elm-doc. Please see the updated README.md for details
• --elm-make flag is not called --elm-path

New behaviors

• Elm 0.19 is the new & only Elm version supported
• Create an .elm-doc directory at the root of the target project as the build directory, which can be changed with --build-dir
• Do not require any C extension to be built when installing elm-doc

v0.3.2

Fixed:

• #12 Build output was not relocatable

0.3.1

Fixes

• #11 Pin package.elm-lang.org (documentation renderer) version to 0.18.0

v0.3.0

Breaking change

Positional arguments that follow the first positional argument are now considered paths to include. Previously, they were passed in to doit.doit_cmd.DoitMain.run. You should now use --doit-args 'args separated by space' for that purpose.

Explicitly specified paths to include take precedence over the --exclude argument: docs are generated/validated even if the paths match the --exclude module pattern.

Added

--force-exclusion flag to reverse the behavior described above: explicitly specified paths to include get ignored if they match the --exclude module pattern.

v0.2.0

• Added support for sysconfcpus (#1)
• Added retrying of elm-package install (#1)

v0.1.0

Works-for-me release.