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

Update edown 0.8.4 #141

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update edown 0.8.4 #141

wants to merge 2 commits into from

Conversation

mopp
Copy link

@mopp mopp commented Jun 7, 2022

Why

erlenv release
24.2 (set by /Users/mopp/.anyenv/envs/erlenv/release)

> erl
Erlang/OTP 24 [erts-12.2] [source] [64-bit] [smp:16:16] [ds:16:16:10] [async-threads:1] [jit]

Eshell V12.2  (abort with ^G)
1>

I've used Erlang/OTP 24.2 and I found rebar3 edoc causes the error below because I tried to fix the documents.
See also #142

> ./_build/rebar3 edoc
===> Verifying dependencies...
===> Analyzing applications...
===> Compiling edown
===> Compiling _build/docs/lib/edown/src/edown_doclet.erl failed
_build/docs/lib/edown/src/edown_doclet.erl:112:15: record context undefined
_build/docs/lib/edown/src/edown_doclet.erl:113:15: record context undefined
_build/docs/lib/edown/src/edown_doclet.erl:114:20: record context undefined

What I did

I just update the down version and regenerate the document.

@@ -80,7 +80,7 @@ Example (simplified `prometheus_vm_memory_collector`):


<pre><code>
collect_mf_callback() = fun((<a href="prometheus_model.md#type-MetricFamily">prometheus_model:'MetricFamily'()</a>) -&gt; any())
collect_mf_callback() = fun((<a href="http://www.erlang.org/edoc/doc/prometheus/doc/prometheus_model.html#type-MetricFamily">prometheus_model:'MetricFamily'()</a>) -&gt; any())
Copy link
Author

@mopp mopp Jun 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I checked the diff of the edown but these changes may not cause these changes.
uwiger/edown@0.8.1...0.8.4

@deadtrickster So I've expected that you do git restore these wrong links on your local afterrebar3 edoc.
Should I replace the wrong links manually? Or do you know any workaround?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found the doc_path option.
See https://github.com/uwiger/edown/tree/master/doc#links-to-other-edown-generated-docs

However, it does not work as I expected because the application name and the repository name are different... 😢

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

Successfully merging this pull request may close these issues.

None yet

1 participant