pdamoc/elm-docset

Elm Docset generator

elm-docset's Issues

Include some guide pages?

Thanks for this docset, it works really well!

Would you be open to including some of the elm guides in the set?

http://elm-lang.org/docs/syntax would be the main one, but also perhaps records, ports, effect managers and some of the new pages from http://guide.elm-lang.org/ ?

Elm 0.17

Hi, Thank for creating this docset. Can you update for elm 0.17? Thanks a lot

Redundant package name

See:
Kapeli/Dash-User-Contributions#875

AttributeError: 'strlist' object has no attribute 'encode'

I just tried to regenerate for Elm 0.16, but always get that error. Any pointers?

$ python generate.py                  
starting ...
cleanig up... DONE!
feching all packages list ... DONE!
feching new packages list ... DONE!
Traceback (most recent call last):
  File "generate.py", line 336, in <module>
    generate_all()
  File "generate.py", line 292, in generate_all
    fo.write(indexTemplate({"pkgs":[(pkg["name"], docname(pkg["name"]), pkg["summary"]) for pkg in pkgs]}))
  File "~/work/elm-docset/templates.py", line 125, in <lambda>
    indexTemplate = lambda d: pybars.Compiler().compile(index)(d, helpers={"pkglist":pkglist}).encode("utf-8")
AttributeError: 'strlist' object has no attribute 'encode'

Possible to generate docs for unpublished code?

I've generated a documentation.json file using elm-make --docs=documentation.json and can preview it using this tool, but I'd like to have a local copy of it (this code is part of a web app in development and it doesn't make sense to publish these modules, so getting the code in Elm's online documentation isn't sensible).

I'd like to include this in doc viewers that take docsets, like Dash or Zeal.

Is it possible to use your elm-docset tool to generate a new docset that includes an unpublished documentation.json file?

Thank you.

Elm has a nice logo but it needn't dictate syntax highlighting

Hi there - Thank you for providing this nice documentation. You know the green colour that's used in the docset for the colons and arrows in type signatures?

Its RGB value seems to have been picked directly off the Elm logo (the tangram thing), which is cute, but for actual use, that bright green colour is not very readable against a bright white background!

How about toning it down to an unassuming #aaa or something? I think it's set here in the CSS.

cc @kraklin

HTML tags in package summaries breaks the main docset index.

I'm not sure if this is even visible on Dash, but the index.html generated in Elm.docset/Contents/Resources/Documents/ breaks if one of the summaries contains HTML tags (as massung/elm-css does).

The fix is to escape the summary string. I'm unsure whether others should be escaped, or whether pybars3 has its own better, global, escaping strategy than just using cgi.escape(), or whether more than just &, <, and > should be escaped.

I've included a minimal changeset just to fix this issue though.

Updating

Hi, Peter!

What's your process for updating this docset? I've just cloned your repo and I'm generating the docsets over again at intervals for myself. But I'd like to offer my help if it's simple to publish the docsets I'm generating.

Update for Elm 0.19

How difficult would it be to update the docset now that Elm 0.19 is released? Would you like some help with this?

The generator does not generate parentheses in the type unions.

see http://package.elm-lang.org/packages/elm-lang/http/1.0.0/Http#Error

Error trying generate elm-docset in Windows

Hi, I am trying to generate elm-docset in windows to used it in Zeal.
however, after i install all depedency like markdown, requests, and pybars3
there are error such as:

(dash) C:\Users\user\Downloads\Project\elm-docset>python generate.py
  File "generate.py", line 289
    print "Error in ", self.package, self.name
                    ^
SyntaxError: Missing parentheses in call to 'print'

(dash) C:\Users\user\Downloads\Project\elm-docset>

I use Python 3.4.4 for windows 64bit.

Thanks.

Thank you SO MUCH!

I just wanted to say "thank you SO MUCH" for adding an Elm docset to dash. Life is so much better now!

Missing documentation

The doc page on Task provides more information than I can find in the docset which only provide type information.

Unqualified indexed entry results

I'm opening the issue here under the assumption that this is the same Docset as the one published in the User Docsets Page, as disclosed in the README.

I'm using Zeal and when searching for e.g. "always", it retrieves even exports from random third-party packages. I wasn't sure of which of those options was actually the elm/core function because all of them are tagged as function with no further discrimination (it was the third one).

I've found it's also impossible to narrow down the search, as in, querying for List.map doesn't work.

Would it be feasible to properly qualify all index entries, given that fuzzy matching will still catch incomplete words if you want to be unspecific? I like that the whole ecosystem is bundled in there but between the conflicting names and multiple type-specific implementations, plus third-party packages exports overlap all over the place, makes this quite unusable for me.

Core docs don't come up in search in Dash

Although they seem to be included in the docset (I can get there sometimes by clicking links in succession), stdlib docs never come up for me. Typing "indexedMap" brings up only third party code, and "List.map" brings up nothing. The way I'm generally going to search is with the module name like List.map, so it'd be great if this worked.

Error when generating docset

Thank you so much for this generator, I love it. However, on my most recent attempt to generate docs, I'm getting this error:

...
Generating package: capitalist/elm-octicons [ 82 / 683]...Traceback (most recent call last):
  File "generate.py", line 373, in <module>
    generate_all()
  File "generate.py", line 349, in generate_all
    html = toHtml(module.markdown).replace('<code>', '<code class="elm">') # fix syntax detection
  File "generate.py", line 277, in get_markdown
    ret.append(self.expand_docs(pre[len(pre_):]))
  File "generate.py", line 244, in expand_docs
    if item.startswith("docs"): item = item.split()[1]
IndexError: list index out of range

My Python is extremely limited, so I don't know what to make of this.

Zeal reports that documentation feed is invalid

Thank you for creating this docset, I'm really keen to have this working in Zeal.

I followed the instructions here to try to add the Elm docset to my installation of Zeal. I.e. click "Add feed" in Options > Docsets in Zeal, paste http://london.kapeli.com/feeds/zzz/user_contributed/build/Elm/Elm.tgz, click "Ok".

Zeal runs an uploading dialogue for a few seconds building up to 100%, then pops up an error, "Invalid docset feed!"

Any ideas what might be going wrong? I've downloaded the docset manually and it seems ok to me.