userguide.php 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?php
  2. return [
  3. // Enable the API browser. TRUE or FALSE
  4. 'api_browser' => TRUE,
  5. // Enable these packages in the API browser. TRUE for all packages, or a string of comma seperated packages, using 'None' for a class with no @package
  6. // Example: 'api_packages' => 'Kohana,Kohana/Database,Kohana/ORM,None',
  7. 'api_packages' => TRUE,
  8. // Enables Disqus comments on the API and User Guide pages
  9. 'show_comments' => Kohana::$environment === Kohana::PRODUCTION,
  10. // Leave this alone
  11. 'modules' => [
  12. // This should be the path to this modules userguide pages, without the 'guide/'. Ex: '/guide/modulename/' would be 'modulename'
  13. 'userguide' => [
  14. // Whether this modules userguide pages should be shown
  15. 'enabled' => TRUE,
  16. // The name that should show up on the userguide index page
  17. 'name' => 'Userguide',
  18. // A short description of this module, shown on the index page
  19. 'description' => 'Documentation viewer and api generation.',
  20. // Copyright message, shown in the footer for this module
  21. 'copyright' => '&copy; 2008–2014 Kohana Team',
  22. ]
  23. ],
  24. // Set transparent class name segments
  25. 'transparent_prefixes' => [
  26. 'Kohana' => TRUE,
  27. ]
  28. ];