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
17
votes
6 answers

How to build sphinx documentation for django project

I have a django project, which I document using reST in docstrings to do the following: Help diagloags within IDE Later on to build HTML documentation using Sphinx My documentation shows up properly within IDE (PyCharm), however I can't configure…
miki725
  • 27,207
  • 17
  • 105
  • 121
17
votes
1 answer

Jupyter Notebook Python auto docstring generation with triple quotation

I'm working in a jupyter notebook using python and trying to use the auto-documentation function to generate docstrings like below. When working in an IDE like pycharm a triple quotation + Enter underneath the function generates docstrings like…
17
votes
2 answers

How to use IEnumerable in documenting code

I have this method which I am trying to generate documentation. /// /// This method demonstrates taking a Func as argument and perform that action(Func) on a list of strings. /// ...…
17
votes
1 answer

Is there a documentation standard for custom XML style attributes in Android?

I am able to document pretty much everything in in my Android projects and generate nice-looking API references for them. The only exception to this are the XML files, and especially the attribute files that contain the styleable attributes. For…
MasterAM
  • 16,283
  • 6
  • 45
  • 66
17
votes
4 answers

How do I prevent the GitHub Pages "Automatic Generator" to remove everything before regenerate the site?

I created a wonderful GitHub Pages website for my little project, and I added some other pages into the gh-pages branch. My problem is that, everytime I regenerate the website from 'Settings=>Automatic Page Generator', everything is cleaned up and I…
16
votes
2 answers

Is there an @inheritDoc equivalent in Doxygen?

I know Javadoc will compile {@inheritDoc}, but what's the Doxygen way to do this?
Roberto
  • 11,557
  • 16
  • 54
  • 68
16
votes
3 answers

Generate JSON schema from typescript

I am trying to create a typescript doc-generator, but to do so, i need to parse a typescript file into something more easily readable EX: "Command": { "description": "A command object for the command handler", "constructor": [ { …
DusterTheFirst
  • 317
  • 1
  • 4
  • 15
16
votes
1 answer

Sphinx-apidoc on django build html failure on `django.core.exceptions.AppRegistryNotReady`

Question background: I want to write documents with sphinx on my django project and auto create docs with my django code comments. Now I have a django(1.9) project, the file structure is as below: myproject/ myproject/ __init__.py …
Alfred Huang
  • 17,654
  • 32
  • 118
  • 189
16
votes
11 answers

Graphviz for documentation

I noticed that doxygen uses the graphviz library for creating diagrams. Have you ever used graphviz for generating documentation? Is it worth learning the graphviz for documentation purposes outside the scope of doxygen? Or am I better off to…
Marcin
  • 12,245
  • 9
  • 42
  • 49
16
votes
1 answer

Generate JavaScript documentation directly from source code

I'm looking for a tool to generate the documentation for JavaScript functions and properties even if there are no appropriately formatted comment blocks associated with those functions or properties (like Doxygen does). This comparison between JSDoc…
Greg
  • 8,230
  • 5
  • 38
  • 53
16
votes
3 answers

Are there any plugins for generating API documentation for Play 2.x?

We have a relatively large REST API build on top of Play 2.x and are tasked with documenting it for our internal users. Since it is our belief that maintaining this on a separate wiki is very difficult, we are wondering if there are any…
Mad Dog
  • 583
  • 4
  • 18
16
votes
1 answer

How to generate Python documentation using Sphinx with zero configuration?

We don't want to be maintaining documentation as well as the source code, which is evolving rapidly at the moment, yet Sphinx seems to require a frustrating amount of setup and configuration. (We just need some basic API docs.) Is there not a…
rosejn
  • 849
  • 1
  • 7
  • 9
15
votes
1 answer

Documentation tools for RPC APIs

There are a variety of good tools out there for source code and API documentation (doxygen, Headerdoc, Sphinx, to name but a few). However, none of them appear especially good at producing documentation for APIs that are provided via an RPC…
Nick Bastin
  • 30,415
  • 7
  • 59
  • 78
15
votes
6 answers

XML Commenting tips for C# programming

Good morning, afternoon, evening or night (depending on your timezone). This is just a general question about XML commenting within C#. I have never been very big into commenting my programs, I've always been more of a verbose…
user26901
15
votes
2 answers

Documenting Interfaces and their implementation

I'm decorating my C# code with comments so I can produce HTML help files. I often declare and document interfaces. But classes implementing those interfaces can throw specific exceptions depending on the implementation. Sometimes, the client is only…