Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
6cd885e8
Commit
6cd885e8
authored
Nov 17, 2014
by
Carsten Brandt
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update README.md
parent
f9d83661
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
8 deletions
+6
-8
README.md
extensions/apidoc/README.md
+6
-8
No files found.
extensions/apidoc/README.md
View file @
6cd885e8
...
@@ -42,22 +42,20 @@ Simple usage for stand alone guide documentation:
...
@@ -42,22 +42,20 @@ Simple usage for stand alone guide documentation:
vendor/bin/apidoc guide source/docs ./output
vendor/bin/apidoc guide source/docs ./output
```
```
You can combine them to generate class API and guide doc in one place:
You can combine them to generate class API and guide doc
umentation
in one place:
```
```
# first generate guide docs to allow links from code to guide you may skip this if you do not need these.
# generate API docs
vendor/bin/apidoc guide source/docs ./output
# second generate API docs
vendor/bin/apidoc api source/directory ./output
vendor/bin/apidoc api source/directory ./output
#
third run guide docs again to have class links enabled
#
generate the guide (order is important to allow the guide to link to the apidoc)
vendor/bin/apidoc guide source/docs ./output
vendor/bin/apidoc guide source/docs ./output
```
```
By default the
`bootstrap`
template will be used. You can choose a different template
s
with the
`--template=name`
parameter.
By default the
`bootstrap`
template will be used. You can choose a different template with the
`--template=name`
parameter.
Currently there is only the
`bootstrap`
template available.
Currently there is only the
`bootstrap`
template available.
You may also add the
`yii\apidoc\commands\
RenderController`
to your console application class map and
You may also add the
`yii\apidoc\commands\
ApiController`
and
`GuideController`
to your console application command map
run it
inside of your applications console app.
and run them
inside of your applications console app.
### Advanced usage
### Advanced usage
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment