Skip to content

Library that allows to import php documentation into Confluence via rest api

License

Notifications You must be signed in to change notification settings

Code-Mine-Development/PhpDoc-Confluence-Importer

Repository files navigation

Build Status Code Coverage VersionEye Scrutinizer Code Quality

PhpDoc Confluence Importer

Library that allows to import php documentation into Confluence via rest api

Designed to work with PhpDocumentator xml output and PhpUnit testdox html files.

Different documentation/build artifact exporters are also considered.

TODO

  1. Confluence API OO wrapper
  2. XML to page data converter
  3. Wiki renderer
  4. Page exporter
  5. CLI interface

Usage (Planned)

php doc2confluence.php [command] [args]  

commands:
export phpdoc
  -s --source : source xml file generated by PhpDocumentor
  -c --credentials : username:password - Confluence user credentials that has access to desired space
  -S --space : space key to which pages need to be imported
  -h --host : Confluence instance url
  -p --parent : identifier of the parent page, if not provided, pages will be created in space root
  
export testdox
  -s --source : source file generated by Phpunit
  -c --credentials : username:password - Confluence user credentials that has access to desired space
  -S --space : space key to which page need to be imported
  -h --host : Confluence instance url
  -p --parent : identifier of the parent page, if not provided, pages will be created in space root

Bitdeli Badge

About

Library that allows to import php documentation into Confluence via rest api

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages