Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I often hack out some Thor, Rake, Bash or even PHP commandline tools. And I want to document the command-line-arguments and variations in a consistent way.
Is there an official, or recommended standard on this documentation?
Like when an option is optional[--foo=bar], or when an option can be one n-values ("yes|no"), etceteras.
I'd rather not come up with my own standard, when there is an official (POSIX?) standard or guide that already lists the do's and don't for documenting tools and applications on CLI's.
I'm not sure what output format you have in mind, but why not use the man-page style? It seems a nice fit for commandline tools.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I like the idea of relishapp.com, i.e. that you have Cucumber / Gherkin features and you generate "living docs" from them. However, the Relish SaaS is awful.
I'm looking for an alternative. Ideally self-hosted Open Source like Sphinx, but I'm not completely opposed to SaaS solutions. Especially Sphinx would be great as I could combine it with other docs and use readthedocs.org for deployment.
So the question is: What would be the easiest way to generate HTML docs from Gherkin features?
There is one more option Cukedoctor https://github.com/rmpestano/cukedoctor
You can host within company network using SimpleHTTPServer ( http://2ality.com/2014/06/simple-http-server.html )
I've used yard-cucumber to do that before. It worked out pretty well.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I wanted to know the spell correct api's available for commercial/non commercial usage other than google/bing.
First of all you can write your own spell corrector with this tutorial. In addition there are some Python packages that may help you with that, such as TextBlob (which I highly recommend). Another option is Gingerit which Iv'e never tried but looks promising. Another DIY spell correct tutorial might interest you as well.
https://www.gigablast.com/spellcheckapi.html
I just launched this, so it's still beta, but it's not bad. It has a dictionary of over 600,000,000 entries covering most non-Asian languages.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I've been programming in common lisp for a while now, and I like how there's so much handy documentation on the language online; the problem is that I'm often offline and can't access it when I need it most.
Is there a PyDoc equivalent for common lisp (or even just man pages for the language) that I can download and use in the shell?
Cheers in advance.
You can download the CLHS and install it in various ways.
http://www.cliki.net/CLHS
that's an old question…
edit: as referenced on the Cookbook, we can read the HyperSpecs offline with either Dash (MacOS), Zeal (GNU/Linux) or Velocity (Windows).
we could ask or add it on devdocs: https://devdocs.io/
and take the data of the CL Ultra Spec: website, data
and of course browse the built-in documentation with Emacs (C-h, see the menu).
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Is there a cheatsheet that compares the usage of Markdown with Restructure? With this, I could learn rst faster if I already knew Markdown. I tried google for it but haven't found one..
A small comparsion from a lot lightweight markup language syntaxs can be found on Wikipedia.
There is also a Gist document about the common markup between the two languages.
You can use Pandoc to convert your existing Markdown to reST or the other way around.
There are a lot of different Markdown dialects, so it may be difficult to compare the syntax with reST.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Is there a document editor that helps formatting documents like API documents or specifications?
I prefer not to use Word but something that is more productive.
LaTeX is particularly well-suited to technical documents, I find.
Depending on the language you use, specially for API documentations, I'd use XML comments and then use a program like SandCastle and SHFB.