Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.

Commit 73c7ac9

Browse files
committed
Merge pull request #26 from froschdesign/docs/switch-from-bookdown-to-mkdocs
Removes Bookdown config and updates MkDocs config
2 parents 0b3a83a + 25074af commit 73c7ac9

File tree

7 files changed

+48
-52
lines changed

7 files changed

+48
-52
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
.*.un~
88
nbproject
99
tmp/
10+
doc/html/
11+
zf-mkdoc-theme/
1012

1113
clover.xml
1214
composer.lock
1315
coveralls-upload.json
1416
phpunit.xml
15-
doc/html/
1617
vendor/

.travis.yml

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ branches:
1010
cache:
1111
directories:
1212
- $HOME/.composer/cache
13+
- $HOME/.local
14+
- zf-mkdoc-theme
15+
16+
env:
17+
global:
18+
- SITE_URL: https://zendframework.github.io/zend-eventmanager
19+
- GH_USER_NAME: "Matthew Weier O'Phinney"
20+
- GH_USER_EMAIL: [email protected]
21+
- GH_REF: github.com/zendframework/zend-eventmanager.git
22+
- secure: ""
1323

1424
matrix:
1525
fast_finish: true
@@ -21,6 +31,8 @@ matrix:
2131
- php: 5.6
2232
env:
2333
- EXECUTE_TEST_COVERALLS=true
34+
- DEPLOY_DOCS="$(if [[ $TRAVIS_BRANCH == 'master' && $TRAVIS_PULL_REQUEST == 'false' ]]; then echo -n 'true' ; else echo -n 'false' ; fi)"
35+
- PATH="$HOME/.local/bin:$PATH"
2436
- php: 7
2537
- php: hhvm
2638
allow_failures:
@@ -33,21 +45,20 @@ notifications:
3345
before_install:
3446
- if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
3547
- composer self-update
36-
- if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then composer require --dev --no-update phly/bookdown2mkdocs ; fi
3748
- if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then composer require --dev --no-update satooshi/php-coveralls ; fi
3849

3950
install:
4051
- travis_retry composer install --no-interaction --ignore-platform-reqs --prefer-source
4152
- composer info -i
4253

43-
before_script:
44-
- if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then cp mkdocs.yml mkdocs.yml.orig ; fi
45-
4654
script:
4755
- if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/phpunit --coverage-clover clover.xml ; fi
4856
- if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then ./vendor/bin/phpunit ; fi
4957
- if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/phpcs ; fi
50-
- if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then make mkdocs ; diff mkdocs.yml mkdocs.yml.orig ; return $? ; fi
58+
- if [[ $DEPLOY_DOCS == "true" && "$TRAVIS_TEST_RESULT" == "0" ]]; then wget -O theme-installer.sh "https://raw.githubusercontent.com/zendframework/zf-mkdoc-theme/master/theme-installer.sh" ; chmod 755 theme-installer.sh ; ./theme-installer.sh ; fi
59+
60+
after_success:
61+
- if [[ $DEPLOY_DOCS == "true" ]]; then echo "Preparing to build and deploy documentation" ; ./zf-mkdoc-theme/deploy.sh ; echo "Completed deploying documentation" ; fi
5162

5263
after_script:
5364
- if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/coveralls ; fi

doc/book/index.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<div class="container">
2+
<div class="jumbotron">
3+
<h1>zend-eventmanager</h1>
4+
5+
<p>
6+
Powerful event bus system for Zend Framework
7+
</p>
8+
9+
<pre><code class="language-bash">$ composer require zendframework/zend-eventmanager</code></pre>
10+
</div>
11+
</div>

doc/book/lazy-listeners/bookdown.json

Lines changed: 0 additions & 10 deletions
This file was deleted.

doc/book/migration/bookdown.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

doc/bookdown.json

Lines changed: 0 additions & 17 deletions
This file was deleted.

mkdocs.yml

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,25 @@ docs_dir: doc/book
22
site_dir: doc/html
33
pages:
44
- index.md
5-
- { Overview: intro.md }
6-
- { 'Quick Start': quick-start.md }
7-
- { Tutorial: tutorial.md }
8-
- { 'Wildcard Listeners': wildcard-listeners.md }
9-
- { 'Listener Aggregates': aggregates.md }
10-
- { 'Lazy Listeners': [{ Introduction: lazy-listeners/intro.md }, { LazyListener: lazy-listeners/lazy-listener.md }, { LazyEventListener: lazy-listeners/lazy-event-listener.md }, { LazyListenerAggregate: lazy-listeners/lazy-listener-aggregate.md }] }
11-
- { Examples: examples.md }
12-
- { 'EventManager API': api.md }
13-
- { 'Intercepting Filters': intercepting-filters.md }
14-
- { 'Migration Guide': [{ Introduction: migration/intro.md }, { 'Removed Functionality': migration/removed.md }, { 'Changed Functionality': migration/changed.md }] }
5+
- Intro: intro.md
6+
- "Quick Start": quick-start.md
7+
- Tutorial: tutorial.md
8+
- Reference:
9+
- "Wildcard Listeners": wildcard-listeners.md
10+
- "Listener Aggregates": aggregates.md
11+
- "Lazy Listeners":
12+
- Intro: lazy-listeners/intro.md
13+
- LazyListener: lazy-listeners/lazy-listener.md
14+
- LazyEventListener: lazy-listeners/lazy-event-listener.md
15+
- LazyListenerAggregate: lazy-listeners/lazy-listener-aggregate.md
16+
- Examples: examples.md
17+
- "EventManager API": api.md
18+
- "Intercepting Filters": intercepting-filters.md
19+
- "Migration Guide":
20+
- Intro: migration/intro.md
21+
- "Removed Functionality": migration/removed.md
22+
- "Changed Functionality": migration/changed.md
1523
site_name: zend-eventmanager
16-
site_description: 'zend-eventmanager: Powerful event bus system for Zend Framework'
24+
site_description: "zend-eventmanager: Powerful event bus system for Zend Framework"
1725
repo_url: 'https://github.com/zendframework/zend-eventmanager'
1826
copyright: 'Copyright (c) 2016 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'

0 commit comments

Comments
 (0)