-
-
Notifications
You must be signed in to change notification settings - Fork 122
Add new template for running yii2-apidoc on a user-submitted project #151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,6 +38,12 @@ class ApiController extends BaseController | |
| */ | ||
| public $repoUrl; | ||
|
|
||
| /** | ||
| * @var string URL for the README to use for the index of the guide. | ||
| * @since 2.0.7 | ||
| */ | ||
| public $readmeUrl = "https://raw.github.com/yiisoft/yii2-framework/master/README.md"; | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why URL instead of local file path? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That URL was hard-coded in the bootstrap template which I copied. For it to work without changing the command line params, it has to match the value that was in the previous template. |
||
|
|
||
|
|
||
| // TODO add force update option | ||
| /** | ||
|
|
@@ -56,6 +62,7 @@ public function actionIndex(array $sourceDirs, $targetDir) | |
|
|
||
| $renderer->apiUrl = './'; | ||
| $renderer->guidePrefix = $this->guidePrefix; | ||
| $renderer->readmeUrl = $this->readmeUrl; | ||
|
|
||
| if ($this->pageTitle !== null) { | ||
| $renderer->pageTitle = $this->pageTitle; | ||
|
|
@@ -195,6 +202,6 @@ protected function findRenderer($template) | |
| */ | ||
| public function options($actionID) | ||
| { | ||
| return array_merge(parent::options($actionID), ['guide', 'guidePrefix', 'repoUrl']); | ||
| return array_merge(parent::options($actionID), ['guide', 'guidePrefix', 'readmeUrl', 'repoUrl']); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
templates/project/ApiRenderer.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| <?php | ||
| /** | ||
| * @link http://www.yiiframework.com/ | ||
| * @copyright Copyright (c) 2008 Yii Software LLC | ||
| * @license http://www.yiiframework.com/license/ | ||
| */ | ||
|
|
||
| namespace yii\apidoc\templates\project; | ||
|
|
||
| use Yii; | ||
| use yii\apidoc\helpers\ApiIndexer; | ||
| use yii\helpers\Console; | ||
| use yii\helpers\FileHelper; | ||
|
|
||
| /** | ||
| * | ||
| * @author Carsten Brandt <mail@cebe.cc> | ||
| * @since 2.0 | ||
| */ | ||
| class ApiRenderer extends \yii\apidoc\templates\bootstrap\ApiRenderer | ||
| { | ||
| use \yii\apidoc\templates\bootstrap\RendererTrait; | ||
|
|
||
| public $layout = '@yii/apidoc/templates/bootstrap/layouts/api.php'; | ||
| public $indexView = '@yii/apidoc/templates/bootstrap/views/index.php'; | ||
|
|
||
| /** | ||
| * @inheritdoc | ||
| */ | ||
| public function render($context, $targetDir) | ||
| { | ||
| // render view files | ||
| parent::render($context, $targetDir); | ||
|
|
||
| if ($this->controller !== null) { | ||
| $this->controller->stdout('generating extension index files...'); | ||
| } | ||
|
|
||
| $types = array_merge($context->classes, $context->interfaces, $context->traits); | ||
|
|
||
| $appTypes = $this->filterTypes($types, 'app'); | ||
|
|
||
| // It's a hack, but we'll go with it for now. | ||
| $readme = @file_get_contents($this->readmeUrl); | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Silencing errors isn't good. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I suppose I could throw an exception here. Would that be preferred? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just for the record, Bootstrap template silences errors, too:
$readme = @file_get_contents("https://raw.github.com/yiisoft/yii2-framework/master/README.md");
|
||
| $indexFileContent = $this->renderWithLayout($this->indexView, [ | ||
| 'docContext' => $context, | ||
| 'types' => $appTypes ?: null, | ||
| 'readme' => $readme ?: null, | ||
| ]); | ||
|
|
||
| file_put_contents($targetDir . '/index.html', $indexFileContent); | ||
| } | ||
| } | ||
23 changes: 23 additions & 0 deletions
templates/project/GuideRenderer.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <?php | ||
| /** | ||
| * @link http://www.yiiframework.com/ | ||
| * @copyright Copyright (c) 2008 Yii Software LLC | ||
| * @license http://www.yiiframework.com/license/ | ||
| */ | ||
|
|
||
| namespace yii\apidoc\templates\project; | ||
|
|
||
| use Yii; | ||
| use yii\apidoc\helpers\ApiIndexer; | ||
| use yii\helpers\Console; | ||
| use yii\helpers\FileHelper; | ||
|
|
||
| /** | ||
| * | ||
| * @author Carsten Brandt <mail@cebe.cc> | ||
| * @since 2.0 | ||
| */ | ||
| class GuideRenderer extends \yii\apidoc\templates\bootstrap\GuideRenderer | ||
| { | ||
| use \yii\apidoc\templates\bootstrap\RendererTrait; | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.