kapeli / dash-user-contributions Goto Github PK

I found a docset generator for Appcelerator Titanium.
https://github.com/jkozera/zeal/blob/master/gendocsets/extjs/parse.py
But It looks a old version.

Can you share your docset generator for Appcelerator Titanium?
If you can, I'll make a docset for other Appcelerator Docs & Guide easily.

The official documentation is located here:
http://matplotlib.org/contents.html

FYI I created a docket for npm.
I'll look into the checklist and see how to share it with others...

API Reference can be found here:
http://pyside.github.io/docs/pyside/

Craig Bishop already created a docset of an older version:
https://github.com/craig-bishop/pyside-dash-docset

Thanks for Dash! I’ve been using it daily for weeks now, and it is the first documentation app that I really love using.

There are a few things the Ampersand docset could do with in the next update:

• General Updates: There have been several minor updates to the Ampersand.js docs that add up to a reasonably-sized update.
• Missing docs (in ampersand-state):
  • The Dash docs have a heading for dataTypes, but no content under it
  • The Dash docs are missing the collections property (note that it is plural—collections—not to be confused with the singular property collection, which Dash does include)
• Guides: The (non-user contributed) docset for CoffeeScript includes a “Guides” section on the left-hand navigation bar. It would be helpful if the Ampersand.js docset also included a “Guides” section, corresponding to the guides on Ampersand’s Learn page.

It would be really nice with a local copy of https://metacpan.org

I'm the contributor of the Atom.io docset, it's quite outdated now and I don't have the time to keep up with the changes.

Perhaps it might be best to remove this docset for now and I'll take another look at it once they reach a 1.0 version and hopefully the changes to the API slow down a little.

Also happy for anyone else to take over this if they have time/interest.

The "Generating Dash Docsets" instructions state that a ToC can be generated by adding special "//apple_ref" links to a docset. There seems to be more to it than that, though. I've tried adding tags to a docset as described, then removing and re-adding my docset in Dash's preferences, but Dash never shows a ToC. I've looked through a number of existing docsets that have tables of contents, and they all seem to use different flavors of tags (//apple_ref vs //dash_ref with a variety of types such as "clm"), and all include .dashtoc JSON files, which aren't mentioned anywhere in the instructions.

Is there some relationship that should exist between ToC tag names and search index names?

For the Copy your docset generation script or any other required resources step of the process, would it be acceptable to add my generation script repo as a submodule?

API Reference can be found here:
https://developer.chrome.com/extensions
API index:
https://developer.chrome.com/extensions/api_index

or the one by Opera
https://github.com/operasoftware/extension-docs

http://deeplearning.net/software/theano/library/index.html#libdoc

I'd like to contribute a cheat sheet, but I'm a bit confused. Is the method different for Cheat Sheets as opposed to DocSets? When I look at the source of some cheat sheets I have installed it appears to have a different file structure than what you recommend in the contribution instructions.

Should I just add a copy of a different cheat sheet to my fork and modify that?

Hi,

I enjoy using your software, but I think that one thing is missing: use translated docs.

For instance, PHP docs exists in french, but Dash has only the english one.. so what about adding locale settings ?

#185

The command "wget http://kapeli.com/feeds/zzz/docsetcontrib.tgz && tar -xzf docsetcontrib.tgz && ./docsetcontrib --verify" exited with 1.
Done. Your build exited with 1.

"IPython", not "iPython"

http://ipython.org/

First,your app is the best thing to happen to Developers on Macintosh :)
But anytime i open the bootstrap 3 documentation,the app crashes, i have installed about 3 different versions of the bootstrap documentation
Kindly Help me fix this problem thank You,

OpenCL 1.2: https://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/
OpenCL 2.0: https://www.khronos.org/registry/cl/sdk/2.0/docs/man/xhtml/

From https://www.mnot.net/blog/2014/06/07/rfc2616_is_dead:

• RFC7230 - HTTP/1.1: Message Syntax and
  Routing -
  low-level message parsing and connection management
• RFC7231 - HTTP/1.1: Semantics and
  Content -
  methods, status codes and headers
• RFC7232 - HTTP/1.1: Conditional Requests - e.g.,
  If-Modified-Since
• RFC7233 - HTTP/1.1: Range Requests - getting partial
  content
• RFC7234 - HTTP/1.1: Caching - browser and
  intermediary caches
• RFC7235 - HTTP/1.1: Authentication - a framework for HTTP
  authentication

Would be sweet to Dash "http 301" or "http content-type" and the like. :)

http://peewee.readthedocs.org/en/latest/

http://pillow.readthedocs.org/reference/index.html
thx~

docsets: https://github.com/gsmlg/raphael-dash-gen

Hey. I've made the docset for openstack and it literally is about 110 MB... just over the 100MB limit. If you include the pdf's, it goes to 140MB or so.

Can we work out a way to host the docset somewhere else?

Thanks.

Is it possible to add threejs docset?

Bogdan,
I'm a bit confused by the proposed workflow.

If I understood it right, you'd like contributors to fork this repo, containg n docset, in order to work on 1 docset. That aside, I don't get if you want to keep track of source, generation and final docset, or just some of these?

You say that once the tarballs are on the CDN, you'll remove them from the repo, meaning you'll rewrite git history by filtering out the tarballs (git rm won't cut it). In doing so, it means you won't be tracking the final docset. Moreover, you are ok with git submodules for source/generation, so you won't track changes for real. Which leaves the meta resources - docset.json, icons, ..

Wasn't it enough to have this repo only as a git submodules' manager, and all submodules would point to generated docset, ready to be tarballed (by you, the CDN manager) ? In addition, this repo could have a validator executable so that any contribution is tested on e.g. Travis-CI for passing necessary requirements?

The documentation is here: https://docs.magentocommerce.com/

Would be really cool to have this. Maybe if I someday get how the docset generation is "done right" I may create an PR, but if someone is faster than me he may contribute. :)

Additionally also all base classes, which I don't know if they are stated in the upper docs. I guess generating from source would be the best...

Normally my Docset would have the same version as my app, i.e. my app is at 0.3 so my docset is called 0.3, etc. But my Docset changes more frequently than my version. This is because I have decoupled my modules from my app itself into two separate projects, so that the modules may have any number of updates when the app itself is on the same version. What do you recommend for a versioning scheme for my docset in this case? Should it have its own versioning scheme then, starting with 1.0 or something?

Hi, the sklearn doc in Dash is 0.14, while the latest version should be 0.15.
Anyone could help with updating the doc? Or anyone can give me a hint how I can translate the http://scikit-learn.org/stable/documentation.html into Dash's flavor format?

Add support for Materialize (http://materializecss.com/).

My repo is newer than this repo, Is there a way to send pull request without folk?
https://github.com/ifree/glut-docset
https://github.com/ifree/sawfish-docset
https://github.com/ifree/sdl2-docset

http://docs.slimframework.com/

I tried to follow the tutorial, but I don't know how to add the HTML things into the sqlite-file.

Maybe somebody want to do this?

Current version of the matplotlib docset is 1.3.1, please update it to 1.4.3 if possible.

Thanks very much!!!!

Here is the documentation: http://sailsjs.org/#/documentation/

Currently: 2.2.1

Should be: 2.2.2

I'm wondering how URL paths are supposed to work.

My database looks like:

CREATE TABLE searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT);

A sample row is:

1120        Test::Able::Planner                   http://metacpan.org/pod/Test::Able::Planner                  Package

Test::Able::Planner shows up in the index, but won't load the URL specified in the path. I think pulling the full set of HTML for CPAN will be north of 250MB which seems a bit large.

I installed DashLookup, when Export dashlookup as deployable plugin, I got some error, below is error info, Could you help me deal with this?

/Users/lynn/Documents/workspace-java/.metadata/.plugins/org.eclipse.pde.core/temp/org.eclipse.pde.container.feature/assemble.org.eclipse.pde.container.feature.p2.xml:38: The following error occurred while executing this line:
/Users/lynn/Documents/workspace-java/.metadata/.plugins/org.eclipse.pde.core/temp/org.eclipse.pde.container.feature/assemble.org.eclipse.pde.container.feature.p2.xml:48: The following error occurred while executing this line:
/Users/lynn/Documents/workspace-java/.metadata/.plugins/org.eclipse.pde.core/temp/org.eclipse.pde.container.feature/assemble.org.eclipse.pde.container.feature.p2.xml:24: The following error occurred while executing this line:
/Users/lynn/Documents/workspace-java/DashLookup/build.xml:244: The following error occurred while executing this line:
/Users/lynn/Documents/workspace-java/DashLookup/build.xml:348: Problem: failed to create task or type apitooling.apigeneration
Cause: The name is undefined.
Action: Check the spelling.
Action: Check that any custom tasks/types have been declared.
Action: Check that any / declarations have taken place.

The following error occurred while executing this line:
/Users/lynn/Documents/workspace-java/.metadata/.plugins/org.eclipse.pde.core/temp/org.eclipse.pde.container.feature/assemble.org.eclipse.pde.container.feature.p2.xml:48: The following error occurred while executing this line:
/Users/lynn/Documents/workspace-java/.metadata/.plugins/org.eclipse.pde.core/temp/org.eclipse.pde.container.feature/assemble.org.eclipse.pde.container.feature.p2.xml:24: The following error occurred while executing this line:
/Users/lynn/Documents/workspace-java/DashLookup/build.xml:244: The following error occurred while executing this line:
/Users/lynn/Documents/workspace-java/DashLookup/build.xml:348: Problem: failed to create task or type apitooling.apigeneration
Cause: The name is undefined.
Action: Check the spelling.
Action: Check that any custom tasks/types have been declared.
Action: Check that any / declarations have taken place.

I am trying to follow the instructions for creating an updated version of the Astropy docset at

https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/Astropy

since the repository version is for astropy 0.3.2 (the current version is astropy 0.4.2). I dumped the site using

httrack "http://docs.astropy.org/en/stable/" -O "Astropy" "+docs.astropy.org/en/stable/" -v

and that appears to have worked fine. However when I try the doc2dash command

doc2dash -v -n Astropy Astropy/docs.astropy.org/en/stable/.

I get the following output:

Converting sphinx docs from "Astropy/docs.astropy.org/en/stable/." to "./Astropy.docset".
Parsing documentation...
Traceback (most recent call last):
File "/Users/####//anaconda/bin/doc2dash", line 11, in
sys.exit(main())
File "/Users/####/anaconda/lib/python2.7/site-packages/click/core.py", line 572, in call
return self.main(_args, *_kwargs)
File "/Users/####//anaconda/lib/python2.7/site-packages/click/core.py", line 552, in main
rv = self.invoke(ctx)
File "/Users/####//anaconda/lib/python2.7/site-packages/click/core.py", line 744, in invoke
return ctx.invoke(self.callback, *_ctx.params)
File "/Users/####//anaconda/lib/python2.7/site-packages/click/core.py", line 388, in invoke
return callback(_args, **kwargs)
File "/Users/####//anaconda/lib/python2.7/site-packages/doc2dash/main.py", line 126, in main
for entry in doc_parser.parse():
File "/Users/####//anaconda/lib/python2.7/site-packages/doc2dash/parsers/sphinx.py", line 56, in parse
for t in _parse_soup(soup):
File "/Users/####//anaconda/lib/python2.7/site-packages/doc2dash/parsers/sphinx.py", line 86, in _parse_soup
dd = dt.next_sibling.next_sibling
AttributeError: 'NoneType' object has no attribute 'next_sibling'
Exception RuntimeError: 'sys.path must be a list of directory names' in <generator object patch_anchors at 0x10695feb0> ignored

As near as I can tell, this implies some sort of problem with the directory structure of the Astropy docs compared to what doc2dash was expecting. Any ideas?

here is documentation link : http://sequelize.readthedocs.org

First, apologies if I'm breaking the process! Two questions on the submission process for you:

• in the versioning guidelines it talks about the format expected for version numbers. does this just apply to the version keys in docset.json, the directory names under the versions subdirectory, or both? For my docset (for CanJS btw), we want to use versions like 2.0.7/2014-03-26. From the documentation, I wasn't sure where to apply the /.
• When reviewing the docset I generated, noticed that our embedded jsFiddle examples don't work properly (example at the bottom of this page http://canjs.com/docs/can.Control.html). Do IFRAMEs not work at all in Dash documentation files? I did read that external resources should be avoided and am working on avoiding that if possible, but I thought the contents of the frames would load at least.

I made a docset for matplotlib, but it's 117.82MB so github did not let me upload it :[

Here it is on Dropbox:
http://goo.gl/5edDnH
is there a way to add it from there ?

Hi,

I'd like to request Timber docs to be added to the Dash. I was able to get them by myself using a PHP generator but I know it's not looking the way it should ie. every HTML converted file is set as a Class in Dash. It would be great if someone could do the proper ones from this github wiki : https://github.com/jarednova/timber/wiki

If anyone is interested in the version I created via the generator you can find it here : https://cloudup.com/cbwbtru8U6L

Thank you!

Update : fixed the url for the zippped file.

Hello,
just to let you know you made an error on my name: it is Massart, not -Massaer-

Thank you

So I have a functional CPAN docset (with all docs downloaded locally!)

tar'ed and gzip -9 gives me a 140M tarball (down from 1.2G)

If I understand correctly I need the following:

• Tarball of my CPAN.docset
• Icons 16x16 and 32x32 (I have these in the docset already)
• json file

Do the icons and json file go into the docset tarball or do they stay outside? What's the best way for me to get you the docset (since it blows out githubs 100MB limit). I can put it on dropbox ...

Newly called B4A

http://docs.sqlalchemy.org/en/rel_0_9/

@chenglou can you please update the React docset?

"scikit" is a confusing name for @iamaziz's scikit-learn docset, since there's also scikit-image that's fairly widely used and a bunch of others that are less used.

http://pygraphviz.github.io/documentation/pygraphviz-1.3rc1/

thx

I know that the Doxygen documents can be convert to docset easily on Mac OS. But I use Zeal on Linux. When I try to generate the docset, I can't found the alternatives for the 'docsetutil' provided by Xcode.
So, would you please offer the ffmpeg docset?

http://kivy.org/docs/api-kivy.html

Julia please!

http://docs.julialang.org/en/release-0.3/