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

Commit fbf0948

Browse files
committed
Merge pull request #48 from froschdesign/docs/switch-from-bookdown-to-mkdocs
[Docs] Switch from Bookdown to MkDocs
2 parents eef2052 + fde2a2e commit fbf0948

File tree

13 files changed

+46
-13
lines changed

13 files changed

+46
-13
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,6 @@ coveralls-upload.json
1111
nbproject
1212
phpunit.xml
1313
tmp/
14+
doc/html/
15+
zf-mkdoc-theme/
1416
vendor/

.travis.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ branches:
1010
cache:
1111
directories:
1212
- $HOME/.composer/cache
13+
- $HOME/.local
14+
- zf-mkdoc-theme
1315

1416
addons:
1517
apt:
@@ -21,6 +23,11 @@ env:
2123
global:
2224
- TESTS_ZEND_LDAP_ONLINE_ENABLED=true
2325
- COMPOSER_ARGS="--no-interaction --ignore-platform-reqs"
26+
- SITE_URL: https://zendframework.github.io/zend-ldap
27+
- GH_USER_NAME: "Matthew Weier O'Phinney"
28+
- GH_USER_EMAIL: matthew@weierophinney.net
29+
- GH_REF: github.com/zendframework/zend-ldap.git
30+
- secure: ""
2431

2532
matrix:
2633
fast_finish: true
@@ -42,6 +49,8 @@ matrix:
4249
env:
4350
- DEPS=locked
4451
- TEST_COVERAGE=true
52+
- DEPLOY_DOCS="$(if [[ $TRAVIS_BRANCH == 'master' && $TRAVIS_PULL_REQUEST == 'false' ]]; then echo -n 'true' ; else echo -n 'false' ; fi)"
53+
- PATH="$HOME/.local/bin:$PATH"
4554
- php: 5.6
4655
env:
4756
- DEPS=latest
@@ -91,6 +100,11 @@ script:
91100
- if [[ $TEST_COVERAGE == 'true' ]]; then composer test-coverage ; fi
92101
- if [[ $TEST_COVERAGE != 'true' ]]; then composer test ; fi
93102
- if [[ $CHECK_CS == 'true' ]]; then composer cs-check ; fi
103+
- 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
104+
105+
after_success:
106+
- if [[ $DEPLOY_DOCS == "true" ]]; then echo "Preparing to build and deploy documentation" ; ./zf-mkdoc-theme/deploy.sh ; echo "Completed deploying documentation" ; fi
107+
94108

95109
after_script:
96110
- if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer upload-coverage ; fi
File renamed without changes.

doc/book/index.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<div class="container">
2+
<div class="jumbotron">
3+
<h1>zend-ldap</h1>
4+
5+
<p>
6+
Zend\Ldap\Ldap is a class for performing LDAP operations including
7+
but not limited to binding, searching and modifying entries in an
8+
LDAP directory.
9+
</p>
10+
11+
<pre><code class="language-bash">$ composer require zendframework/zend-ldap</code></pre>
12+
</div>
13+
</div>

doc/book/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../README.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)