Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

edoc behaviors need special treatment? #9

Open
norton opened this Issue · 4 comments

3 participants

@norton

I don't have any good idea how to handle edoc behaviors except to remove them before generating the markdown output.

Any other ideas?

https://github.com/norton/ubf-thrift

diff --git a/doc/ubf_thrift_plugin.md b/doc/ubf_thrift_plugin.md
index 95b87fc..1089624 100644
--- a/doc/ubf_thrift_plugin.md
+++ b/doc/ubf_thrift_plugin.md
@@ -10,7 +10,7 @@ Sample Thrift contract.

-Behaviours: [ubf_plugin_stateless](https://github.com/norton/ubf/blob/master/doc/plug
+Behaviours: [ubf_plugin_stateless](/Users/norton/github/master/ubf-all/src/lib/ubf/do

##Description##

@tolbrino

I'm trying to reproduce your problem, but run into the error below. Any idea?

tino:ubf-thrift/ (master) $ ./rebar doc                                  [11:46:53]
==> meck (doc)
edoc: skipping source file './src/meck_mod.erl': {'EXIT',{{badmatch,{error,enoent}},[{asciiedoc_lib,expand_text,2},{asciiedoc_lib,parse_xml,2},{meck,exec,5},{edoc_wiki,parse_xml,[[77,111|...],20]},{edoc_tags,parse_tag,4},{edoc_tags,parse_tags,5},{edoc_extract,get_tags,6},{edoc_extract,source1,...}]}}.
edoc: skipping source file './src/meck.erl': {'EXIT',{{badmatch,{error,enoent}},[{asciiedoc_lib,expand_text,2},{asciiedoc_lib,parse_xml,2},{meck,exec,5},{edoc_wiki,parse_xml,[[77,111|...],19]},{edoc_tags,parse_tag,4},{edoc_tags,parse_tags,5},{edoc_extract,get_tags,6},{edoc_extract,source1,...}]}}.
edoc: error in doclet 'asciiedown_doclet': {'EXIT',{{badmatch,{error,enoent}},[{asciiedoc_lib,expand_text,2},{asciiedoc_lib,parse_xml,2},{meck,exec,5},{edoc_wiki,parse_xml,[[10,10,61,61,32,65,98|...],22]},{edoc_tags,parse_tag,4},{edoc_tags,parse_tags,5},{edoc_extract,file,4},{edown_doclet,read_file,4}]}}.
@norton

Try the following recipe:

$ git clone git://github.com/norton/ubf-thrift.git ubf_thrift
$ ./rebar get-deps
$ ./rebar compile
$ ./rebar skip_deps=true doc
$ git diff

You will also need to install asciidoc (http://www.methods.co.nz/asciidoc/INSTALL.html) to reproduce the same edown output. I use asciiedoc (https://github.com/norton/asciiedoc) for edoc purposes.

Otherwise, you can try to disable asciiedoc by changing to edown_doclet in the rebar.config file.

@uwiger
Collaborator

Any news on this issue? Is it still a problem?

@norton

Yes, I see the same behaviour with latest edown (and asciiedoc).

Here is an updated recipe:

$ git clone git://github.com/ubf/ubf-thrift.git ubf_thrift
$ cd ubf_thrift
$ make deps
$ make compile
$ make doc
$ git diff

diff --git a/doc/ftbf.md b/doc/ftbf.md
index 399111e..ac9c16a 100644
--- a/doc/ftbf.md
+++ b/doc/ftbf.md
@@ -4,7 +4,7 @@
 * [Function Index](#index)
 * [Function Details](#functions)

-__Behaviours:__ [`contract_proto`](contract_proto.md).
+__Behaviours:__ [`contract_proto`](contract_proto.html).
 <a name="index"></a>

 ## Function Index ##
....
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.