Create documentation (in AsciiDoc or similar)

[GoogleCodeExporter]

Within Debian, all executables are supposed to have a man page. Therefore, I 
created one for Debian using help2man, which basically converts the output of 
`gitinspector.py --help` to troff format.

My only changes to this output were:
  1. Dropping the '.py' suffix from gitinspector
  2. Adding an introductory sentence (as it is customary) and
  3. Changing the "SEE ALSO" section to reference git(1).

I thought it couldn't hurt to ask whether you might want to include this 
upstream.

Original issue reported on code.google.com by debian.k...@gmail.com on 8 Nov 2014 at 9:58

Attachments:

• gitinspector.1

[GoogleCodeExporter]

And yet again filed as a defect instead of an enhancement -- sorry!

Original comment by debian.k...@gmail.com on 8 Nov 2014 at 10:00

[GoogleCodeExporter]

Neat tool.

However, my plan is to use something like AsciiDoc and also include the 
information under

https://code.google.com/p/gitinspector/wiki/Documentation

There is some really helpful information there. Using AsciiDoc would also make 
it possible to generate anything from a man page to a pdf.

I'm renaming the issue summary to describe the task.

/Adam Waldenberg

Original comment by gitinspe...@ejwa.se on 20 Nov 2014 at 2:37

• Changed title: Create documentation (in AsciiDoc or similar)
• Changed state: Accepted
• Added labels: Type-Enhancement, Usability
• Removed labels: Type-Defect

[GoogleCodeExporter]

[deleted comment]

[GoogleCodeExporter]

[deleted comment]

[GoogleCodeExporter]

[deleted comment]

[GoogleCodeExporter]

Pushing this up to 0.4.0 instead.

Original comment by gitinspe...@ejwa.se on 22 Feb 2015 at 12:07

[GoogleCodeExporter]

This issue was closed by revision e8648a51c26e.

Original comment by gitinspe...@ejwa.se on 22 Feb 2015 at 10:23

• Changed state: Fixed