Questions tagged [documentation-generation]

A documentation generator is a programming tool that generates documentation intended for programmers (API documentation) or end users (End-user Guide), or both, from a set of specially commented source code files, and in some cases, binary files.

A documentation generator is a programming tool that generates documentation intended for programmers (API documentation) or end users (End-user Guide), or both, from a set of specially commented source code files, and in some cases, binary files.

Document generation can be divided in several type of documents:

  • Batch documents (all automated documents)
  • Interactive documents (documents that can not be produced automatically)
  • Text block correspondence (documents created based on pre-defined text blocks)
  • Forms (forms for websites)

You can place every type of document you come across in one of these categories. A lot of software solutions are offered on the Internet that can automate these processes. In particular, some integrated development environments provide interactive access to documentation, code metadata, etc.

See more information about language support for generation programs at Comparison of documentation generators.

832 questions
0
votes
1 answer

Is there any existing service in HotDocs tools to receive data from an external source to prepare a document?

HotDocs is a tool to generate documents and basically it carries 2 things. First is temple and second is answer file. Template carries variables and data to those variables are pushed through answer file. Generally answer file is page where is it…
Manojkumar
  • 1,351
  • 5
  • 35
  • 63
0
votes
1 answer

Generating a Sphinx document with a blockdiag diagram without title pages

I am trying to use Sphinx to generate a blockdiag diagram with an accompanying description table, as described in the example under "desctable" here in the blockdiag documentation. I set up a very simple sphinx project; there is nothing in the main…
nukeguy
  • 416
  • 1
  • 7
  • 20
0
votes
1 answer

Haskell haddock automatic documentation

I have not been able to generate documentaion for haskell using haddock. So far I have not found any useful examples. The documentation has a lot of options and also I am not sure about the comment syntax so that documentation is correctly…
lesolorzanov
  • 3,536
  • 8
  • 35
  • 53
0
votes
1 answer

How to create example of arrays in RAML v1.0

I am trying to create an example of array in RAML v1.0. I do not think it is specified in specification document. I can not find it there. I need this output in resource example section: { tracks: [{ track:12 }, { track:121 …
0
votes
2 answers

Generate a DOC for a REST API

I have generated my REST API, and now I have to write a documentation for the API. As the API is mainly generated by a third-party plugin it's not possible to generate the DOC automatically. So what the best tool (to save time) to manually write a…
sf_tristanb
  • 8,725
  • 17
  • 74
  • 118
0
votes
0 answers

Sandcastle - combine RoutePrefix and Route to get full URI

I am using Sandcastle Help File Builder to document an API. I would like to automate as much of the process as possible, not only to make it easier for the devs to add new routes as they are added, but also to update the documentation. The comments…
Andrew
  • 1,544
  • 1
  • 18
  • 36
0
votes
1 answer

Unresolved assembly in Sandcastle

I configured Microsoft.OData.Client v 6.13.0 for Microsoft.OData.ProxyExtensions in shfbproj file. Microsoft.OData.ProxyExtensions accepts any OData.Client >= 6.11.0 based on the information on MS website, so this should be good. (Both of them are…
user1888955
  • 626
  • 1
  • 9
  • 27
0
votes
0 answers

Python - Sphinx: vague Import error

I am trying to generate API documentation from comments (in numpydoc style) in my project and I am stuck at vague import errors from sphinx: /home/carbolymer/workspace/si-app/doc/source/scripts.rst:10: WARNING: autodoc: failed to import module…
0
votes
4 answers

Is there software/a script that can automatically create class structures for PHP scripts?

I know that PHPDoc exists, but phpdoc wants you to put comments in your PHP files so that it can parse them... What I want is something different: Suppose that I have 10 PHP classes... all I want is a script that can read those classes and…
kamikaze_pilot
  • 14,304
  • 35
  • 111
  • 171
0
votes
1 answer

automated document creation

Are there any existing solutions to create documents in Silverlight? Looking to create purchase orders, contracts, etc. Printing is a desired feature.
Viktor
  • 702
  • 3
  • 8
  • 20
0
votes
1 answer

Enterprise Architect - Generate Documentation - Include Document Artifact as attachment

I have an excel document artifact which I have uploaded as a Internal document and associated to requirement element. Is it possible to embed this document as an attachment when using the option "Generate Documentation"?
0
votes
2 answers

JavaScript Documentation generator Cloud9 IDE

Background I just finished a small HTML5 project in cloud9 IDE. My project is composed of an index.html file, 3 JavaScript files, and a custom styles.css file. I know I cannot document HTML and CSS, but since the core of my project is the JavaScript…
0
votes
1 answer

Error while generating API docs using Enunciate

I created a webservice and would like to generate documentation for the API. So I looked into Enunciate downloaded the maven enunciate plugin. However I get the below error on compile as the webservice annotations are on my interface class that my…
Vijay Kumar
  • 2,439
  • 2
  • 32
  • 51
0
votes
1 answer

readthedocs, local instance, building documentation never concludes

I started with fresh install of readthedocs.org: http://read-the-docs.readthedocs.org/en/latest/install.html Next I have added SocialApp GitHub in admin panel and then connected my superuser to that GitHub account. Then I went to github and I forked…
Drachenfels
  • 3,037
  • 2
  • 32
  • 47
0
votes
1 answer

Using LuaDoc with extensions other than .lua

I am currently developing lua scripts for a new application which requires the extension to be xx_lua. I have luadoc working fine for .lua extensions and I know I could simply rename the files to the lua extension create the documents and rename…
Jane T
  • 2,081
  • 2
  • 17
  • 23