Top "Documentation-generation" questions

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.

Autodocumenting Python using Sphinx

This is a generalized version of a previous question regarding Sphinx. Is there a way to recursively autodocument modules or …

python documentation-generation python-sphinx
How to document Python function parameters with sphinx-apidoc?

I'm trying to clean up my python code documentation, and decided to use sphinx-doc because it looks good. I like …

python python-sphinx documentation-generation api-doc
What are the main differences of Sphinx and Doxygen?

I want to prepare a documentation for a collection of projects, modules and libraries in the field of computer vision (…

c++ opencv python-sphinx doxygen documentation-generation
code documentation for python

What is out there on conventions and tools for documenting python source code?

python documentation documentation-generation
How to automatically generate Python API documentation in PyCharm

I have a Python project in PyCharm and I'd like to automatically generate API documentation (in the form of HTML) …

python pycharm python-sphinx documentation-generation docutils
Create spec for REST API in Enterprise Architect

My customer wants me to create a specification for a future REST API by using Enterprise Architect (SparxSystems). The deliverable …

rest uml documentation-generation enterprise-architect
Graphviz for documentation

I noticed that doxygen uses the graphviz library for creating diagrams. Have you ever used graphviz for generating documentation? Is …

uml doxygen documentation-generation graphviz
How to generate Microsoft Word documents using Sphinx

Sphinx supports a few output formats: Multiple HTML files (with html or dirhtml) Latex which is useful for creating .pdf …

ms-word python-sphinx documentation-generation
How can I document data sets with roxygen?

Is it possible to include .R files in the data directory of my package in the roxygen process? I have …

r documentation-generation r-package roxygen
Documenting C++/CLI library code for use from c# - best tools and practices?

I'm working on a project where a c++/cli library is being used primarily from a c# application. Is there …

documentation c++-cli doxygen documentation-generation