diff --git a/.gitignore b/.gitignore index 4cac0a21..1f2615af 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,8 @@ .*.un~ nbproject tmp/ +doc/html/ +zf-mkdoc-theme/ clover.xml coveralls-upload.json diff --git a/.travis.yml b/.travis.yml index c5487f92..479675f5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,10 +10,17 @@ branches: cache: directories: - $HOME/.composer/cache + - $HOME/.local + - zf-mkdoc-theme env: global: - COMPOSER_ARGS="--no-interaction --ignore-platform-reqs" + - SITE_URL: https://zendframework.github.io/zend-view + - GH_USER_NAME: "Matthew Weier O'Phinney" + - GH_USER_EMAIL: matthew@weierophinney.net + - GH_REF: github.com/zendframework/zend-view.git + - secure: "" matrix: fast_finish: true @@ -35,6 +42,8 @@ matrix: env: - EXECUTE_TEST_COVERALLS=true - DEPS=locked + - DEPLOY_DOCS="$(if [[ $TRAVIS_BRANCH == 'master' && $TRAVIS_PULL_REQUEST == 'false' ]]; then echo -n 'true' ; else echo -n 'false' ; fi)" + - PATH="$HOME/.local/bin:$PATH" - php: 5.6 env: - DEPS=lastest @@ -78,6 +87,10 @@ script: - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/phpunit --coverage-clover clover.xml ; fi - if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then ./vendor/bin/phpunit ; fi - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/php-cs-fixer fix -v --diff --dry-run ; fi + - 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 + +after_success: + - if [[ $DEPLOY_DOCS == "true" ]]; then echo "Preparing to build and deploy documentation" ; ./zf-mkdoc-theme/deploy.sh ; echo "Completed deploying documentation" ; fi after_script: - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/coveralls ; fi diff --git a/doc/book/zend.view.helpers.advanced-usage.md b/doc/book/helpers.advanced-usage.md similarity index 100% rename from doc/book/zend.view.helpers.advanced-usage.md rename to doc/book/helpers.advanced-usage.md diff --git a/doc/book/zend.view.helpers.base-path.md b/doc/book/helpers.base-path.md similarity index 100% rename from doc/book/zend.view.helpers.base-path.md rename to doc/book/helpers.base-path.md diff --git a/doc/book/zend.view.helpers.cycle.md b/doc/book/helpers.cycle.md similarity index 100% rename from doc/book/zend.view.helpers.cycle.md rename to doc/book/helpers.cycle.md diff --git a/doc/book/zend.view.helpers.doctype.md b/doc/book/helpers.doctype.md similarity index 100% rename from doc/book/zend.view.helpers.doctype.md rename to doc/book/helpers.doctype.md diff --git a/doc/book/zend.view.helpers.flash-messenger.md b/doc/book/helpers.flash-messenger.md similarity index 100% rename from doc/book/zend.view.helpers.flash-messenger.md rename to doc/book/helpers.flash-messenger.md diff --git a/doc/book/zend.view.helpers.gravatar.md b/doc/book/helpers.gravatar.md similarity index 100% rename from doc/book/zend.view.helpers.gravatar.md rename to doc/book/helpers.gravatar.md diff --git a/doc/book/zend.view.helpers.head-link.md b/doc/book/helpers.head-link.md similarity index 100% rename from doc/book/zend.view.helpers.head-link.md rename to doc/book/helpers.head-link.md diff --git a/doc/book/zend.view.helpers.head-meta.md b/doc/book/helpers.head-meta.md similarity index 100% rename from doc/book/zend.view.helpers.head-meta.md rename to doc/book/helpers.head-meta.md diff --git a/doc/book/zend.view.helpers.head-script.md b/doc/book/helpers.head-script.md similarity index 100% rename from doc/book/zend.view.helpers.head-script.md rename to doc/book/helpers.head-script.md diff --git a/doc/book/zend.view.helpers.head-style.md b/doc/book/helpers.head-style.md similarity index 100% rename from doc/book/zend.view.helpers.head-style.md rename to doc/book/helpers.head-style.md diff --git a/doc/book/zend.view.helpers.head-title.md b/doc/book/helpers.head-title.md similarity index 100% rename from doc/book/zend.view.helpers.head-title.md rename to doc/book/helpers.head-title.md diff --git a/doc/book/zend.view.helpers.html-list.md b/doc/book/helpers.html-list.md similarity index 100% rename from doc/book/zend.view.helpers.html-list.md rename to doc/book/helpers.html-list.md diff --git a/doc/book/zend.view.helpers.html-object.md b/doc/book/helpers.html-object.md similarity index 100% rename from doc/book/zend.view.helpers.html-object.md rename to doc/book/helpers.html-object.md diff --git a/doc/book/zend.view.helpers.identity.md b/doc/book/helpers.identity.md similarity index 100% rename from doc/book/zend.view.helpers.identity.md rename to doc/book/helpers.identity.md diff --git a/doc/book/zend.view.helpers.inline-script.md b/doc/book/helpers.inline-script.md similarity index 100% rename from doc/book/zend.view.helpers.inline-script.md rename to doc/book/helpers.inline-script.md diff --git a/doc/book/zend.view.helpers.json.md b/doc/book/helpers.json.md similarity index 100% rename from doc/book/zend.view.helpers.json.md rename to doc/book/helpers.json.md diff --git a/doc/book/zend.view.helpers.md b/doc/book/helpers.md similarity index 100% rename from doc/book/zend.view.helpers.md rename to doc/book/helpers.md diff --git a/doc/book/zend.view.helpers.partial.md b/doc/book/helpers.partial.md similarity index 100% rename from doc/book/zend.view.helpers.partial.md rename to doc/book/helpers.partial.md diff --git a/doc/book/zend.view.helpers.placeholder.md b/doc/book/helpers.placeholder.md similarity index 100% rename from doc/book/zend.view.helpers.placeholder.md rename to doc/book/helpers.placeholder.md diff --git a/doc/book/zend.view.helpers.url.md b/doc/book/helpers.url.md similarity index 100% rename from doc/book/zend.view.helpers.url.md rename to doc/book/helpers.url.md diff --git a/doc/book/index.html b/doc/book/index.html new file mode 100644 index 00000000..8d7bd7f4 --- /dev/null +++ b/doc/book/index.html @@ -0,0 +1,11 @@ +
+
+

zend-view

+ +

+ Zend\View provides the "View" layer of Zend Framework's MVC system. +

+ +
$ composer require zendframework/zend-view
+
+
\ No newline at end of file diff --git a/doc/book/index.md b/doc/book/index.md new file mode 100644 index 00000000..fe840054 --- /dev/null +++ b/doc/book/index.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/doc/book/zend.view.php-renderer.scripts.md b/doc/book/php-renderer.scripts.md similarity index 100% rename from doc/book/zend.view.php-renderer.scripts.md rename to doc/book/php-renderer.scripts.md diff --git a/doc/book/zend.view.quick-start.md b/doc/book/quick-start.md similarity index 100% rename from doc/book/zend.view.quick-start.md rename to doc/book/quick-start.md diff --git a/doc/book/zend.view.renderer.php-renderer.md b/doc/book/renderer.php-renderer.md similarity index 100% rename from doc/book/zend.view.renderer.php-renderer.md rename to doc/book/renderer.php-renderer.md diff --git a/doc/book/zend.view.view-event.md b/doc/book/view-event.md similarity index 100% rename from doc/book/zend.view.view-event.md rename to doc/book/view-event.md diff --git a/doc/bookdown.json b/doc/bookdown.json deleted file mode 100644 index fafea74a..00000000 --- a/doc/bookdown.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "title": "Zend\\View", - "target": "html/", - "content": [ - "book/zend.view.quick-start.md", - "book/zend.view.renderer.php-renderer.md", - "book/zend.view.php-renderer.scripts.md", - "book/zend.view.view-event.md", - "book/zend.view.helpers.md", - "book/zend.view.helpers.base-path.md", - "book/zend.view.helpers.cycle.md", - "book/zend.view.helpers.doctype.md", - "book/zend.view.helpers.flash-messenger.md", - "book/zend.view.helpers.gravatar.md", - "book/zend.view.helpers.head-link.md", - "book/zend.view.helpers.head-meta.md", - "book/zend.view.helpers.head-script.md", - "book/zend.view.helpers.head-style.md", - "book/zend.view.helpers.head-title.md", - "book/zend.view.helpers.html-list.md", - "book/zend.view.helpers.html-object.md", - "book/zend.view.helpers.identity.md", - "book/zend.view.helpers.inline-script.md", - "book/zend.view.helpers.json.md", - "book/zend.view.helpers.partial.md", - "book/zend.view.helpers.placeholder.md", - "book/zend.view.helpers.url.md", - "book/zend.view.helpers.advanced-usage.md" - ] -} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..f27c38ed --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,34 @@ +docs_dir: doc/book +site_dir: doc/html +pages: + - index.md + - "Quick Start": quick-start.md + - View Helpers: + - Intro: helpers.md + - "The PhpRenderer": renderer.php-renderer.md + - "PhpRenderer View Scripts": php-renderer.scripts.md + - "The ViewEvent": view-event.md + - "View Helpers": helpers.md + - BasePath: helpers.base-path.md + - Cycle: helpers.cycle.md + - Doctype: helpers.doctype.md + - "Flash Messenger": helpers.flash-messenger.md + - Gravatar: helpers.gravatar.md + - HeadLink: helpers.head-link.md + - HeadMeta: helpers.head-meta.md + - HeadScript: helpers.head-script.md + - HeadStyle: helpers.head-style.md + - HeadTitle: helpers.head-title.md + - HtmlList: helpers.html-list.md + - HtmlObject: helpers.html-object.md + - Identity: helpers.identity.md + - InlineScript: helpers.inline-script.md + - Json: helpers.json.md + - Partial: helpers.partial.md + - Placeholder: helpers.placeholder.md + - Url: helpers.url.md + - "Advanced usage of helpers": helpers.advanced-usage.md +site_name: zend-view +site_description: zend-view +repo_url: 'https://github.com/zendframework/zend-view' +copyright: 'Copyright (c) 2016 Zend Technologies USA Inc.' \ No newline at end of file