Artur-Sulej / excellent_migrations

An Elixir tool for checking safety of database migrations.
MIT License
242 stars 25 forks source link

Misc doc changes #5

Closed kianmeng closed 2 years ago

kianmeng commented 2 years ago

Besides other documentation changes, this commit includes all relevant documents to the generated HTML doc for HexDocs.pm and leverages on latest features of ExDoc.

Artur-Sulej commented 2 years ago

@kianmeng FYI, I needed to set only: :dev for ex_doc. Otherwise I was not able to publish new version on hex.pm. https://github.com/Artur-Sulej/excellent_migrations/commit/9fba9ec021efc0425922da82f1845df73e56236a

kianmeng commented 2 years ago

@Artur-Sulej Thanks for letting me know.

Maybe this should help?

MIX_ENV=docs mix hex.publish docs

Or amend this to mix.exs:

preferred_cli_env: [
  docs: :docs,
  "hex.publish": :docs
],