Download the PHP package matthiasnoback/sphinx-documentation-collector without Composer

On this page you can find all versions of the php package matthiasnoback/sphinx-documentation-collector. 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?

Example code of matthiasnoback/sphinx-documentation-collector

Informations about the package sphinx-documentation-collector

Sphinx documentation collector

This library provides a tool for collecting different documentation roots from all over your project and combine them into one table of contents file, which will be your project documentation.

Installing Sphinx

Enable PDF

For PHP and/or Symfony-related documentation

Install Sphinx PHP extensions by Fabien Potencier (https://github.com/fabpot/sphinx-php) using Composer:

composer require --dev fabpot/sphinx-php:1.*

Then add the extensions:

# in config.py

import sys

...

sys.path.insert(0, os.path.abspath('../../vendor/fabpot/sphinx-php'))

extensions = [..., 'sensio.sphinx.refinclude', 'sensio.sphinx.configurationblock', 'sensio.sphinx.phpcode']

Configure the PHP lexer to work for code samples without a PHP open tag:

from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer

# enable highlighting for PHP code not between ```` by default
lexers['php'] = PhpLexer(startinline=True)
lexers['php-annotations'] = PhpLexer(startinline=True)

primary_domain = 'php'

# API URL
api_url = 'http://api.symfony.com/master/%s'

Usage

php bin/collect.php build/documentation --library-dir=src/Acme/*/ --library-dir=vendor/acme/*/

The first argument should be the Sphinx documentation directory. Then you need to supply one or more --library-dir options. Those will be used to scan for /meta/doc directories containing an index.rst file. For each of these "documentation roots" a symlink will be created in the build directory. Finally a fresh table of contents is automatically generated: it collects all the index.rst files from all over the project.

All versions of sphinx-documentation-collector with dependencies

PHP Build Version
Package Version
Requires symfony/finder Version 2.*
symfony/filesystem Version 2.*
aura/cli Version 2.*@dev
pimple/pimple Version 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 matthiasnoback/sphinx-documentation-collector contains the following files

Loading the files please wait ....