ueberauth / guardian

Elixir Authentication
MIT License
3.43k stars 382 forks source link

update ex_doc to be able to generate docs #576

Closed Hanspagh closed 5 years ago

Hanspagh commented 5 years ago

Currently mix docs fails with the following error ** (InchEx.Docs.Retriever.Error) module Guardian.Config was not compiled with flag --docs lib/inch_ex/docs/retriever.ex:83: InchEx.Docs.Retriever.verify_module/1 lib/inch_ex/docs/retriever.ex:72: InchEx.Docs.Retriever.get_module/2 (elixir) lib/enum.ex:1314: Enum."-map/2-lists^map/1-0-"/2 lib/inch_ex/docs/retriever.ex:51: InchEx.Docs.Retriever.docs_from_modules/2 lib/inch_ex.ex:39: InchEx.generate_docs/4 lib/mix/tasks/inch.ex:48: Mix.Tasks.Inch.run/4 (mix) lib/mix/task.ex:316: Mix.Task.run_task/3 (mix) lib/mix/cli.ex:79: Mix.CLI.run_task/2

Updating ex_docs fixes this.

yordis commented 5 years ago

@Hanspagh do you need to update the version itself or can we just update the mix.lock with the latest version instead?

We can avoid having to maintain this versioning if so.

codecov-io commented 5 years ago

Codecov Report

Merging #576 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #576   +/-   ##
=======================================
  Coverage   85.51%   85.51%           
=======================================
  Files          18       18           
  Lines         421      421           
=======================================
  Hits          360      360           
  Misses         61       61

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update ce842f7...1b8b808. Read the comment docs.

Hanspagh commented 5 years ago

I guess we can do that, but the odd thing is that it is already 0.19.2 in the lock file. I only updating the deps I was able to get the docs generated