From 43e4913027abe80ab8730438e991d459750c8886 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 20:06:24 +0200 Subject: [PATCH 01/10] [Docs] Rename documentation files --- ...d.view.helpers.advanced-usage.md => helpers.advanced-usage.md} | 0 doc/book/{zend.view.helpers.base-path.md => helpers.base-path.md} | 0 doc/book/{zend.view.helpers.cycle.md => helpers.cycle.md} | 0 doc/book/{zend.view.helpers.doctype.md => helpers.doctype.md} | 0 ...view.helpers.flash-messenger.md => helpers.flash-messenger.md} | 0 doc/book/{zend.view.helpers.gravatar.md => helpers.gravatar.md} | 0 doc/book/{zend.view.helpers.head-link.md => helpers.head-link.md} | 0 doc/book/{zend.view.helpers.head-meta.md => helpers.head-meta.md} | 0 .../{zend.view.helpers.head-script.md => helpers.head-script.md} | 0 .../{zend.view.helpers.head-style.md => helpers.head-style.md} | 0 .../{zend.view.helpers.head-title.md => helpers.head-title.md} | 0 doc/book/{zend.view.helpers.html-list.md => helpers.html-list.md} | 0 .../{zend.view.helpers.html-object.md => helpers.html-object.md} | 0 doc/book/{zend.view.helpers.identity.md => helpers.identity.md} | 0 ...end.view.helpers.inline-script.md => helpers.inline-script.md} | 0 doc/book/{zend.view.helpers.json.md => helpers.json.md} | 0 doc/book/{zend.view.helpers.md => helpers.md} | 0 doc/book/{zend.view.helpers.partial.md => helpers.partial.md} | 0 .../{zend.view.helpers.placeholder.md => helpers.placeholder.md} | 0 doc/book/{zend.view.helpers.url.md => helpers.url.md} | 0 ...{zend.view.php-renderer.scripts.md => php-renderer.scripts.md} | 0 doc/book/{zend.view.quick-start.md => quick-start.md} | 0 ...end.view.renderer.php-renderer.md => renderer.php-renderer.md} | 0 doc/book/{zend.view.view-event.md => view-event.md} | 0 24 files changed, 0 insertions(+), 0 deletions(-) rename doc/book/{zend.view.helpers.advanced-usage.md => helpers.advanced-usage.md} (100%) rename doc/book/{zend.view.helpers.base-path.md => helpers.base-path.md} (100%) rename doc/book/{zend.view.helpers.cycle.md => helpers.cycle.md} (100%) rename doc/book/{zend.view.helpers.doctype.md => helpers.doctype.md} (100%) rename doc/book/{zend.view.helpers.flash-messenger.md => helpers.flash-messenger.md} (100%) rename doc/book/{zend.view.helpers.gravatar.md => helpers.gravatar.md} (100%) rename doc/book/{zend.view.helpers.head-link.md => helpers.head-link.md} (100%) rename doc/book/{zend.view.helpers.head-meta.md => helpers.head-meta.md} (100%) rename doc/book/{zend.view.helpers.head-script.md => helpers.head-script.md} (100%) rename doc/book/{zend.view.helpers.head-style.md => helpers.head-style.md} (100%) rename doc/book/{zend.view.helpers.head-title.md => helpers.head-title.md} (100%) rename doc/book/{zend.view.helpers.html-list.md => helpers.html-list.md} (100%) rename doc/book/{zend.view.helpers.html-object.md => helpers.html-object.md} (100%) rename doc/book/{zend.view.helpers.identity.md => helpers.identity.md} (100%) rename doc/book/{zend.view.helpers.inline-script.md => helpers.inline-script.md} (100%) rename doc/book/{zend.view.helpers.json.md => helpers.json.md} (100%) rename doc/book/{zend.view.helpers.md => helpers.md} (100%) rename doc/book/{zend.view.helpers.partial.md => helpers.partial.md} (100%) rename doc/book/{zend.view.helpers.placeholder.md => helpers.placeholder.md} (100%) rename doc/book/{zend.view.helpers.url.md => helpers.url.md} (100%) rename doc/book/{zend.view.php-renderer.scripts.md => php-renderer.scripts.md} (100%) rename doc/book/{zend.view.quick-start.md => quick-start.md} (100%) rename doc/book/{zend.view.renderer.php-renderer.md => renderer.php-renderer.md} (100%) rename doc/book/{zend.view.view-event.md => view-event.md} (100%) 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/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 From 498107718337181f4500f908d1a5a2cfb7ac2d20 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 20:19:32 +0200 Subject: [PATCH 02/10] [Docs] Switch from Bookdown to MkDocs configuration --- mkdocs.yml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..36b2e833 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,34 @@ +docs_dir: doc/book +site_dir: doc/html +pages: + - index.md + - Intro: intro.md + - Reference: + - "Quick Start": quick-start.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 From 76db793b99ac2cb7e2fad1a4cf0c7fa7647a5d97 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 20:21:17 +0200 Subject: [PATCH 03/10] [Docs] Add symlink for README.md --- doc/book/index.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/book/index.md 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 From 8067373a3bce714fc287e84d28426d8f3e78737a Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 20:23:17 +0200 Subject: [PATCH 04/10] [Docs] Create a doc/book/index.html --- doc/book/index.html | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 doc/book/index.html diff --git a/doc/book/index.html b/doc/book/index.html new file mode 100644 index 00000000..da1c0ad6 --- /dev/null +++ b/doc/book/index.html @@ -0,0 +1,11 @@ +
+
+

zend-view

+ +

+ Create cryptographically secure pseudo-random numbers, and manage big integers. +

+ +
$ composer require zendframework/zend-view
+
+
\ No newline at end of file From 54fa3dc896c08e748fa12b01b9ac0c510810ad1f Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 20:26:18 +0200 Subject: [PATCH 05/10] [Docs] Update .gitignore file --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) 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 From 7ef393fd8ba9163612d43b715a28a0fbf8c38697 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 20:34:24 +0200 Subject: [PATCH 06/10] [Docs] Update .travis.yml file --- .travis.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) 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 From 7676e00066d6781f05b179f81758f22efbead58c Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 20:34:59 +0200 Subject: [PATCH 07/10] [Docs] Remove bookdown.json file --- doc/bookdown.json | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 doc/bookdown.json 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 From e550c2fd8be6acfaaac1305320cb0e0cfba82a44 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 20:39:14 +0200 Subject: [PATCH 08/10] [Docs] Fixes component description in index.html file --- doc/book/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/book/index.html b/doc/book/index.html index da1c0ad6..8d7bd7f4 100644 --- a/doc/book/index.html +++ b/doc/book/index.html @@ -3,7 +3,7 @@

zend-view

- Create cryptographically secure pseudo-random numbers, and manage big integers. + Zend\View provides the "View" layer of Zend Framework's MVC system.

$ composer require zendframework/zend-view
From 528d1b2355fa0096ca917fda91a07962516719b7 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 21:02:32 +0200 Subject: [PATCH 09/10] [Docs] Fixes file list mkdocs.yml --- mkdocs.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 36b2e833..dc7ef6bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,8 +3,9 @@ site_dir: doc/html pages: - index.md - Intro: intro.md - - Reference: - - "Quick Start": quick-start.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 From d4d7d935bfe6855977c003bc8607b6b18d55dee3 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 21:12:18 +0200 Subject: [PATCH 10/10] [Docs] Fixes file list mkdocs.yml (remove intro.md) --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index dc7ef6bd..f27c38ed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,6 @@ docs_dir: doc/book site_dir: doc/html pages: - index.md - - Intro: intro.md - "Quick Start": quick-start.md - View Helpers: - Intro: helpers.md