Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error Generating Docs For Modules With @compile {:autoload, false} #1078

Closed
asummers opened this issue Aug 13, 2019 · 1 comment
Closed

Error Generating Docs For Modules With @compile {:autoload, false} #1078

asummers opened this issue Aug 13, 2019 · 1 comment

Comments

@asummers
Copy link

asummers commented Aug 13, 2019

So we have a module that includes the module attribute:

@compile {:autoload, false}

The context there is some NIF loading code, if that's important.

When running mix docs it produces the following stack trace:

Compiling 1 file (.ex)
** (ExDoc.Retriever.Error) module MyModule is not defined/available
    (ex_doc) lib/ex_doc/retriever.ex:60: ExDoc.Retriever.get_module/2
    (elixir) lib/enum.ex:2994: Enum.flat_map_list/2
    (ex_doc) lib/ex_doc/retriever.ex:43: ExDoc.Retriever.docs_from_modules/2
    (ex_doc) lib/ex_doc.ex:30: ExDoc.generate_docs/3
    (ex_doc) lib/mix/tasks/docs.ex:317: anonymous fn/6 in Mix.Tasks.Docs.run/3
    (elixir) lib/enum.ex:1948: Enum."-reduce/3-lists^foldl/2-0-"/3
    (ex_doc) lib/mix/tasks/docs.ex:316: Mix.Tasks.Docs.run/3
    (mix) lib/mix/task.ex:331: Mix.Task.run_task/3

This module has @moduledoc false and @doc false above all the functions, so I'm not sure if there's something I can do to tell it to not try to do this. When removing the autoload false, it succeeds normally.

@asummers
Copy link
Author

Can confirm this is now fixed after 24d9783. Thanks @josevalim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant