Asciidoctor vs PyDoctor
Asciidoctor
asciidoctor.orgPyDoctor
pydoctor.readthedocs.ioSide by side
| Figure | Asciidoctor | PyDoctor |
|---|---|---|
| Price from | Free | — |
| Free plan | Yes | — |
| Free trial | — | — |
| Open source | — | — |
| Web | Yes | — |
| Windows | Yes | Yes |
| macOS | Yes | Yes |
| Linux | Yes | Yes |
| API | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 0 |
| Spec score · Documentation Generators | 8.9 (#1) | 7.4 (#22) |
| Intended users | The project describes its toolchain as serving people who write and publish AsciiDoc content across platforms and runtimes. | The documentation says pydoctor is probably best suited to documenting libraries with some degree of internal subclassing. |
| Purpose | Asciidoctor parses AsciiDoc source and converts it into publishable formats such as HTML 5 and PDF. | PyDoctor is a standalone API documentation generator that uses static analysis of Python source code. |
Plans
In their own words
Asciidoctor
Asciidoctor is a free, open-source text processor and publishing toolchain for converting AsciiDoc files or strings into formats such as HTML5, DocBook, PDF, EPUB 3 and manual pages. Its core includes converters for HTML5, DocBook 5 and man pages; PDF and EPUB 3 conversion comes from separate gems. Documents can be processed through a command-line interface or Ruby API. Asciidoctor runs with Ruby, on the JVM through AsciidoctorJ, or in JavaScript environments through Asciidoctor.js, and supports Linux, macOS and Windows. The wider ecosystem includes Maven and Gradle plugins, browser and editor extensions, and diagram tools. Default HTML output includes a stylesheet and integrations such as Font Awesome, highlight.js, Rouge, Pygments and MathJax. It is distributed as a RubyGem, Docker image, Linux packages and macOS packages, and is licensed under MIT. Its security modes include SECURE, SAFE, SERVER and UNSAFE; safe modes do not sanitize generated output or provide a comprehensive security framework.
PyDoctor
PyDoctor has no write-up on Specifiction yet; its figures are above.