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.
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 7 years ago.
Improve this question
Is there a service/library (free or paid) that takes a piece of text and return the language of it?
I need to go over a million blog posts and determine their languages.
I think this is the best out there!
https://code.google.com/p/language-detection/
I've heard good things about langid.py.
Features from the README:
Fast
Pre-trained over a large number of languages (currently 97)
Not sensitive to domain-specific features (e.g. HTML/XML markup)
Single .py file with minimal dependencies
Deployable as a web service
https://github.com/saffsd/langid.py
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
For example, in this help page about finding and replacing with gsub() in awk:
I know now that the [ ] used in [, t] means that t is an optional argument, but I only know this now because my colleague told me. He did not know where he learnt this, my guess is that there are some commonly used conventions that help pages follow but I lack the vocabulary to be able to search for such conventions.
What other common formatting conventions are used when it comes to help pages? Where can I find out about them?
What you are looking for is called Command description syntax on Wikipedia or Utility argument syntax in The Open Group Base Specifications.
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 4 years ago.
Improve this question
I'm trying to understand how documentation generators like Doxygen, JavaDocs etc. work. Please don't get me wrong, I'm not asking how to use them, but how they do it. I tried to find information about the topic but only found 1 article which is really old, so I'm kinda frustrated.
Does someone know any articles or literature about this?
For doxygen there is a manual page about the internals of Doxygen.
Some small document generators just use regular expressions to extract the documentation. The more flexible and complicated way is to develop a parser for the language and a parser for the documentation syntax just like doxygen and Javadoc do.
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.
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.