pydoctor - Documentation Tool for Python

  •        1733

pydoctor is an API documentation tool for Python. It works by parsing the source code and processing the syntax trees of Python modules and packages, which has advantages and disadvantages over generating the documentation from examining live objects, as some other documentation tools do.

http://codespeak.net/~mwh/pydoctor/

Tags
Implementation
License
Platform

   




Related Projects

sphinx - Main repository for the Sphinx documentation builder

  •    Python

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

ShoBiz - BizTalk Documentation Tool for Sandcastle

  •    

BizTalk tool that generates Sandcastle documentation from BizTalk artifacts deployed into the databases. Promotes documentation as part of the solution lifecycle. Documentation structure mimics the Admin Console and extracts documentation comments from all sources.

DBDocumenter

  •    

DBDocumenter, an interactive tool designed to generate the SQL Server 2000/2005/2008 documentation. It supports, export of documentation to HTML(WEB) format. It helps the developer , who's design the Data Layer for the application. He/she can easily find the name of column etc...

yard - YARD is a Ruby Documentation tool. The Y stands for "Yay!"

  •    Ruby

YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Below is a summary of some of YARD's notable features. 1. RDoc/SimpleMarkup Formatting Compatibility: YARD is made to be compatible with RDoc formatting. In fact, YARD does no processing on RDoc documentation strings, and leaves this up to the output generation tool to decide how to render the documentation.


DevDocs - API Documentation Browser

  •    Ruby

DevDocs combines multiple API documentations in a fast, organized, and searchable interface.Unless you wish to contribute to the project, I recommend using the hosted version at devdocs.io. It's up-to-date and works offline out-of-the-box.

appledoc - Objective-c code Apple style documentation set generator.

  •    Objective-C

appledoc is command line tool that helps Objective-C developers generate Apple-like source code documentation from specially formatted source code comments. It's designed to take as readable source code comments as possible for the input and use comments as well as surrounding source code to generate visually appealing documentation in the form of HTML as well as fully indexed and browsable Xcode documentation set. Although there are several tools that can create HTML documentation for Objective-C, all of those known to me fall short in meeting the minimum of goals described below. Want to keep updated? Follow us on Twitter - @gentlebytes.

PowerDoc - Database Documenter

  •    

PowerDoc is a collaborative database documentation tool which can be used to create accurate, professional quality database documentation. It keeps an audit of the documentation, so that it is easy to track the changes.

SPDocGen - SharePoint Documentation Generator

  •    

Automatically generate SharePoint Farm Documentation in a few seconds. The application uses the SharePoint Object Model API to produce an XML file containing data from a SharePoint Farm Deployment. The XML file is then transformed into a .doc file (WordML) via XSLT.

rdoc - RDoc produces HTML and online documentation for Ruby projects

  •    Ruby

RDoc produces HTML and online documentation for Ruby projects. RDoc includes the rdoc and ri tools for generating and displaying online documentation.

devdocs - API Documentation Browser

  •    Ruby

DevDocs combines multiple API documentations in a fast, organized, and searchable interface. Unless you wish to contribute to the project, I recommend using the hosted version at devdocs.io. It's up-to-date and works offline out-of-the-box.

Sphinx - Python Documentation Generator

  •    Python

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python. It also supports C and C++. The support for other languages is in the plan. Support for multiple output formats are supported.

doc2dash - Create docsets for Dash.app-compatible API browser.

  •    Python

doc2dash is an MIT-licensed extensible Documentation Set generator intended to be used with the Dash.app API browser for macOS or one of its many free clones for all relevant platforms. doc2dash’s documentation lives at Read the Docs, the code on GitHub. It’s tested on Python 2.7, 3.4+, and PyPy. Both Linux and macOS are tested although certain features are only available on macOS.

swagger - Swagger client generator

  •    Javascript

This is a utility for automatically generating API documentation from annotations in Go code. It generates the documentation as JSON, according to the Swagger Spec, and then displays it using Swagger UI.This tool was inspired by Beego, and follows the same annotation standards set by Beego. The main difference between this tool and Beego is that this generator doesn't depend on the Beego framework. You can use any framework to implement your API (or don't use a framework at all). You just add declarative comments to your API controllers, then run this generator and your documentation is ready! For an example of what such documentation looks like when presented via Swagger UI, see the Swagger pet store example.

codox - Clojure documentation tool

  •    Clojure

A tool for generating API documentation from Clojure or ClojureScript source code. This will generate API documentation in the "target/doc" subdirectory (or wherever your project :target-path is set to).

abao - REST API automated testing tool based on RAML

  •    CoffeeScript

Abao is a command-line tool for testing API documentation written in RAML format against its back-end implementation. With Abao, you can easily plug your API documentation into a Continuous Integration (CI) system (e.g., Travis, Jenkins) and have API documentation up-to-date, all the time. Abao uses Mocha for judging if a particular API response is valid or not. This version of the software only supports the RAML-0.8 specification.

documentation.js - Documentation for modern JavaScript

  •    Javascript

documentation.js is a documentation tool for mordern JavaScript. It Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations. It provides customizable output: HTML, JSON, Markdown, and more.

artifact - The open source design documentation tool for everybody

  •    Rust

Artifact is the simple, linkable and trackable design documentation tool for everybody. It allows anyone to write and link their design documents both to each other and to source code, making it easy to know how complete their project is. Documents are revision controllable, can be edited in the browser and have a full suite of command line tools for searching, displaying, checking, exporting and formatting them. Writing detailed design documents is one of the core pillars of quality software development. Design documents are how you capture the requirements (purpose) of your project and link them to your specifications (how you will build it). They let you get your ideas on paper before writing code, and help you have fewer painful refactors. They create a reference for developers and curious users of how and why your project was developed a certain way, and make it easier to refactor your project when that becomes necessary.

ESDoc - Good Documentation for JavaScript

  •    Javascript

ESDoc is a documentation generator for JavaScript. It generates good documentation. It can measure documentation coverage, Integrate test codes into documentation, Parse ECMAScript proposals.

Python API documentation generation tool

  •    Python

Epydoc is a tool for generating API documentation for Python modules, based on their docstrings. Epydoc supports two output formats (HTML and PDF), and four markup languages for docstrings (Epytext, Javadoc, ReStructuredText, and plaintext).





We have large collection of open source products. Follow the tags from Tag Cloud >>


Open source products are scattered around the web. Please provide information about the open source projects you own / you use. Add Projects.