Skip to content

Commit eb7d78d

Browse files
committed
[skip ci] link class ref to guide
1 parent 814d884 commit eb7d78d

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

guide/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ mkdocs serve
2424
When the guide is ready to be published, build is with :
2525

2626
```
27-
mkdocs build
27+
mkdocs build --clean
2828
```
2929

3030
The user guide is built into the folder `guide\site`.
@@ -42,7 +42,7 @@ To install *apiGen*, [download the apigen.phar](http://apigen.org/apigen.phar) f
4242
From the project's main folder :
4343

4444
```
45-
php apigen.phar generate -s src -d guide\api --template-theme bootstrap --no-source-code --title "yii2-workflow Class Reference"
45+
php apigen.phar generate -s src -d guide\site\class-ref --template-theme bootstrap --no-source-code --title "yii2-workflow Class Reference"
4646
```
4747

48-
The documentation is built into the folder `guide\api`.
48+
The documentation is built into the folder `guide\site\class-ref`.

guide/docs/class-ref.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Visit the [Class Reference Documentation](class-ref/index.html) for a complete description of the **yii2-workflow** implementation.

guide/mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ pages:
1515
- 'The source file compoent' : source-file.md
1616
- 'Upgrade from 1.x' : upgrade.md
1717
- Cookbook: 'special-cookbook.md'
18-
theme: spacelab
18+
- 'Class Reference': 'class-ref.md'
19+
theme: readthedocs

0 commit comments

Comments
 (0)