This repository was archived by the owner on Nov 23, 2023. It is now read-only.
Conversation
TL;DR: it fails
wojtekmach/docs_chunks doesn't pass include flags to EDoc.
I applied the following **hack** just to check if ExDoc can handle
generating nice docs for docsh:
```
diff --git a/src/docs_chunks.erl b/src/docs_chunks.erl
index 47ea431..015e026 100644
--- a/src/docs_chunks.erl
+++ b/src/docs_chunks.erl
@@ -61,7 +61,9 @@
%% '''
-spec edoc_to_chunk(string()) -> docs_v1().
edoc_to_chunk(ErlPath) ->
- {_Module, Doc} = edoc:get_doc(ErlPath, [{preprocess, true}]),
+ Includes = ["/Users/erszcz/work/erszcz/docsh/_build/default/lib/docsh/include"],
+ Opts = [{preprocess, true}, {includes, Includes}],
+ {_Module, Doc} = edoc:get_doc(ErlPath, Opts),
DocString = xpath_to_binary("//module/description/fullDescription", Doc),
Docs = edoc_extract_docs(Doc),
Chunk = docs_v1(DocString, Docs),
```
I then recompiled the script with `mix escript.build` as usual.
The command:
```
r3 compile && \
ERL_LIBS=/Users/erszcz/work/erszcz/docsh/_build/default/lib \
/Users/erszcz/work/wojtekmach/docs_chunks/docs_chunks -project && \
ex_doc docs_chunks "0.7.1" _build/default/lib/docsh/ebin -m docsh
```
Alas, the long output ends with:
```
13:55:58.535 [error] Task #PID<0.107.0> started from #PID<0.102.0> terminating
** (TokenMissingError) nofile:1: missing terminator: end (for "do" starting at line 1)
(elixir) lib/code.ex:553: Code.format_string!/2
(ex_doc) lib/ex_doc/formatter/html/autolink.ex:340: ExDoc.Formatter.HTML.Autolink.format_ast/1
(ex_doc) lib/ex_doc/formatter/html/autolink.ex:288: ExDoc.Formatter.HTML.Autolink.format_and_extract_typespec_placeholders/5
(ex_doc) lib/ex_doc/formatter/html/autolink.ex:226: ExDoc.Formatter.HTML.Autolink.typespec/5
(elixir) lib/enum.ex:1336: Enum."-map/2-lists^map/1-0-"/2
(ex_doc) lib/ex_doc/formatter/html/autolink.ex:205: anonymous fn/6 in ExDoc.Formatter.HTML.Autolink.all_typespecs/2
(elixir) lib/enum.ex:1948: Enum."-reduce/3-lists^foldl/2-0-"/3
Function: &:erlang.apply/2
Args: [#Function<0.96756601/1 in ExDoc.Formatter.HTML.Autolink.all/2>, [%ExDoc.ModuleNode{deprecated: nil, doc: "Store modules' documentation in Docs chunks according to EEP-48.\n\n Add the following code to your project's `rebar.config`:\n\n \n```\n {plugins,\n [\n {rebar3_docsh, \"0.7.1\", {pkg, docsh}}\n ]}.\n \n \n {provider_hooks,\n [\n {post, [{compile, {docsh, compile}}]}\n ]}.\n```\n ", doc_line: 0, docs: [%ExDoc.FunctionNode{annotations: [], arity: 1, defaults: [], deprecated: nil, doc: nil, doc_line: 0, group: "Functions", id: "do/1", name: :do, rendered_doc: nil, signature: "do/1", source_path: "", source_url: nil, specs: [{:"::", [line: 54], [{:do, [line: 54], [{{:., [line: 54], [:rebar_state, :t]}, [line: 54], []}]}, {:|, [line: 54], [{:{}, [line: 54], [:ok, {{:., [line: 54], [:rebar_state, :t]}, [line: 54], []}]}, {:{}, [line: 54], [:error, {:string, [line: 54], []}]}]}]}], type: :function}, %ExDoc.FunctionNode{annotations: [], arity: 1, defaults: [], deprecated: nil, doc: nil, doc_line: 0, group: "Functions", id: "format_error/1", name: :format_error, rendered_doc: nil, signature: "format_error/1", source_path: "", source_url: nil, specs: [{:"::", [line: 65], [{:format_error, [line: 65], [{:any, [line: 65], []}]}, {:iolist, [line: 65], []}]}], type: :function}, %ExDoc.FunctionNode{annotations: [], arity: 1, defaults: [], deprecated: nil, doc: nil, doc_line: 0, group: "Functions", id: "init/1", name: :init, rendered_doc: nil, signature: "init/1", source_path: "", source_url: nil, specs: [{:"::", [line: 39], [{:init, [line: 39], [{{:., [line: 39], [:rebar_state, :t]}, [line: 39], []}]}, {:{}, [line: 39], [:ok, {{:., [line: 39], [:rebar_state, :t]}, [line: 39], []}]}]}], type: :function}], function_groups: ["Functions"], group: nil, id: "rebar3_docsh", module: :rebar3_docsh, nested_context: nil, nested_title: nil, rendered_doc: nil, source_path: "", source_url: nil, title: "rebar3_docsh", type: :module, typespecs: []}]]
** (EXIT from #PID<0.102.0>) an exception was raised:
** (TokenMissingError) nofile:1: missing terminator: end (for "do" starting at line 1)
(elixir) lib/code.ex:553: Code.format_string!/2
(ex_doc) lib/ex_doc/formatter/html/autolink.ex:340: ExDoc.Formatter.HTML.Autolink.format_ast/1
(ex_doc) lib/ex_doc/formatter/html/autolink.ex:288: ExDoc.Formatter.HTML.Autolink.format_and_extract_typespec_placeholders/5
(ex_doc) lib/ex_doc/formatter/html/autolink.ex:226: ExDoc.Formatter.HTML.Autolink.typespec/5
(elixir) lib/enum.ex:1336: Enum."-map/2-lists^map/1-0-"/2
(ex_doc) lib/ex_doc/formatter/html/autolink.ex:205: anonymous fn/6 in ExDoc.Formatter.HTML.Autolink.all_typespecs/2
(elixir) lib/enum.ex:1948: Enum."-reduce/3-lists^foldl/2-0-"/3
```
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR: it fails
https://github.com/wojtekmach/docs_chunks doesn't pass include flags to EDoc.
I applied the following hack just to check if ExDoc can handle generating nice docs for docsh:
I then recompiled the script with
mix escript.buildas usual.The command:
Alas, the long output ends with: