doctum

Generate documentation from code differences

TLDR

Parse a project

$ doctum parse

Render a project

$ doctum render

Parse then render a project

$ doctum update

Parse and render only a specific version of a project

$ doctum update --only-version=[version]

Parse and render a project using a specific configuration

$ doctum update [path/to/config.php]

--ansi
    Forces ANSI output.

--no-ansi
    Disables ANSI output.

--no-interaction
    Do not ask any interactive question.

--help (-h)
    Displays help for a command.

--quiet (-q)
    Do not output any message.

--verbose (-v|-vv|-vvv)
    Increases the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debugging.

--version (-V)
    Displays this application version.

DESCRIPTION

Doctum is a documentation generator for PHP projects. It's an alternative to phpDocumentor, focusing on generating documentation from source code even without detailed PHPDoc comments.

Doctum aims to be fast and efficient. It analyzes your code and generates static HTML documentation that can be easily deployed and hosted. It excels at working with large codebases and can efficiently handle projects with varying levels of code documentation.

Doctum uses a configuration file to specify the project's source code directories, exclude patterns, and other settings. This configuration allows for fine-grained control over the generated documentation, enabling users to customize the output based on their specific needs. It also provides options to customize the theme and appearance of the generated documentation, allowing it to match the overall branding and style of the project.

CAVEATS

Doctum relies on accurate code parsing. While it can handle projects with limited PHPDoc, the quality of documentation is significantly improved by including thorough comments. Ensure you have a recent version of PHP installed that's compatible with Doctum.

COMMANDS

Common Doctum commands include:

update: Generates or updates the documentation for your project.
run: An alias for the update command.
generate: Generates the configuration file.
serve: Starts a local web server to preview the generated documentation.

HISTORY

Doctum was developed as an alternative to existing PHP documentation generators. It aimed to address perceived limitations in performance, flexibility, and ease of use. The project has seen active development and adoption within the PHP community.