doit icon indicating copy to clipboard operation
doit copied to clipboard

Provide documentation for Zeal/Dash

Open vlcinsky opened this issue 8 years ago • 2 comments

As @saimn proposed in ussue #214, providing documentation formatted for Zeal/Dash would be handy as many programmers use it to access their favourite documentation set.

The doc can be generated from Sphinx HTML docs using doc2dash run on Sphinx's HTML output.

There is also sphinxcontrib-dashbuilder which might serve as well (I have no experience with this one).

Resulting doc can be submit to https://github.com/Kapeli/Dash-User-Contributions.

vlcinsky avatar Oct 15 '17 20:10 vlcinsky

Quick test building Dash doc using sphinxcontrib-dashbuilder shows, it is probably broken.

The repository lives on Bitbucket, has very few commits from 2014, has no issue tracker and when I run it, it breaks on "too many values to unpack" (tested on "next" docs repo https://github.com/pydoit/doit-tmp-doc).

My conclusion: we shall use doc2dash.

vlcinsky avatar Oct 15 '17 21:10 vlcinsky

Quick test with doc2dash:

  • on next doc draft version the results are poor as there is no class, method, attribute or function to put into index used by Dash. But the documentation is imported and readable.
  • on existing doc it works better, but as there are only few classes or attributes, there are also not many indexed entries.

Thinking of what information might developer search using Dash, I see these:

  • modules, functions and classes to import and use in dodo file. e.g. doit.action, Interactive, LongRunning, CmdAction.
  • keywords from "task declaration" as actions, file_dep, targets, clean etc.
  • "Guides" or short instructions how to deal with particular topics or task types
  • command line options and subcommands

One question is, what can be modeled by Sphinx and then successfully imported into Dash. Personally I will not care about it until Sphinx doc is set up and working in standard formats.

vlcinsky avatar Oct 15 '17 22:10 vlcinsky