Download the PHP package survos/doc-bundle without Composer

On this page you can find all versions of the php package survos/doc-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package doc-bundle

DocBundle

Generates documentation for a Symfony project. Its primary use today is producing agent-friendly Markdown references — one file per command/entity/workflow, meant to be read by an AI agent (or a human) without scanning the codebase. It also ships a Panther-based screenshot command, and an older Sphinx/RST build command (see the note at the end).

Installation

Configuration

All optional. Each section's include list names command/workflow namespaces or exact names to document; an empty list means "document everything".

Commands

doc:commands

Writes one Markdown file per console command (arguments, options, synopsis, help text) plus an index, filtered by survos_doc.console.include. Standard Symfony global options (--verbose, --env, etc.) are omitted from the output.

doc:entities

Writes one Markdown file per Doctrine entity (fields, types, nullability, relations, and field-bundle metadata — description, group, API/Meilisearch flags — when present), plus an index with a Mermaid ER diagram of the whole schema.

doc:workflows

Writes one Markdown file per registered Symfony Workflow/state machine: an inline Mermaid diagram (renders on GitHub, diffs cleanly as text), a co-located high-resolution .svg, the places/transitions tables, and — when app listeners are subscribed to the workflow's events — their PHP source inline.

Requires symfony/workflow; renders nothing (but doesn't error) if no workflows are registered. The .svg output additionally requires graphviz's dot binary. survos/state-bundle enriches the diagrams with Survos place/transition metadata when installed.

doc:screenshot

Takes a screenshot of a given URL via Symfony Panther (headless Chrome through the local Symfony proxy) and saves it to disk.

Sphinx/RST generation — doc:build (not currently active)

The bundle also has a doc:build command ("Compile .rst.twig files") for rendering .rst.twig templates into Sphinx source, historically used with rst_h() (a Twig function this bundle provides for RST section headers) plus a local Sphinx toolchain:

This path needs further testing before relying on it. Its own test (tests/BuildDocsCommandTest.php) currently fails against the installed Symfony Console version (Application::add() no longer exists), and the test's own success-message assertion no longer matches the command's actual output string — so it's been out of sync with the rest of the bundle for a while. Treat doc:build as unmaintained until someone re-verifies it end to end.

All versions of doc-bundle with dependencies

PHP Build Version
Package Version
Requires php Version ^8.5
symfony/config Version ^8.1
symfony/console Version ^8.1
symfony/dependency-injection Version ^8.1
symfony/http-kernel Version ^8.1
symfony/options-resolver Version ^8.1
twig/twig Version ^3.4|^4.0
symfony/finder Version ^8.1
nadar/php-composer-reader Version ^2.0
survos/kit-bundle Version ^2.5
davidbadura/markdown-builder Version ^1.1
symfony/filesystem Version ^8.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package survos/doc-bundle contains the following files

Loading the files please wait ...