From 0e1e101f4b7099a982533562dca7324349ae417f Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 22:09:09 +0200 Subject: [PATCH 1/6] [Docs] Rename documentation files --- .../{zend.module-manager.best-practices.md => best-practices.md} | 0 doc/book/{zend.module-manager.intro.md => intro.md} | 0 ...d.module-manager.module-autoloader.md => module-autoloader.md} | 0 doc/book/{zend.module-manager.module-class.md => module-class.md} | 0 .../{zend.module-manager.module-manager.md => module-manager.md} | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename doc/book/{zend.module-manager.best-practices.md => best-practices.md} (100%) rename doc/book/{zend.module-manager.intro.md => intro.md} (100%) rename doc/book/{zend.module-manager.module-autoloader.md => module-autoloader.md} (100%) rename doc/book/{zend.module-manager.module-class.md => module-class.md} (100%) rename doc/book/{zend.module-manager.module-manager.md => module-manager.md} (100%) diff --git a/doc/book/zend.module-manager.best-practices.md b/doc/book/best-practices.md similarity index 100% rename from doc/book/zend.module-manager.best-practices.md rename to doc/book/best-practices.md diff --git a/doc/book/zend.module-manager.intro.md b/doc/book/intro.md similarity index 100% rename from doc/book/zend.module-manager.intro.md rename to doc/book/intro.md diff --git a/doc/book/zend.module-manager.module-autoloader.md b/doc/book/module-autoloader.md similarity index 100% rename from doc/book/zend.module-manager.module-autoloader.md rename to doc/book/module-autoloader.md diff --git a/doc/book/zend.module-manager.module-class.md b/doc/book/module-class.md similarity index 100% rename from doc/book/zend.module-manager.module-class.md rename to doc/book/module-class.md diff --git a/doc/book/zend.module-manager.module-manager.md b/doc/book/module-manager.md similarity index 100% rename from doc/book/zend.module-manager.module-manager.md rename to doc/book/module-manager.md From 463670227fca7ef619648216473ef2cd9e73f05e Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 22:13:48 +0200 Subject: [PATCH 2/6] [Docs] Switch from Bookdown to MkDocs configuration --- doc/bookdown.json | 11 ----------- mkdocs.yml | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 11 deletions(-) delete mode 100644 doc/bookdown.json create mode 100644 mkdocs.yml diff --git a/doc/bookdown.json b/doc/bookdown.json deleted file mode 100644 index b4eae34..0000000 --- a/doc/bookdown.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "title": "Zend\\Module-manager", - "target": "html/", - "content": [ - "book/zend.module-manager.intro.md", - "book/zend.module-manager.module-manager.md", - "book/zend.module-manager.module-class.md", - "book/zend.module-manager.module-autoloader.md", - "book/zend.module-manager.best-practices.md" - ] -} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c40b1f8 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,14 @@ +docs_dir: doc/book +site_dir: doc/html +pages: + - index.md + - Intro: intro.md + - Reference: + - "The Module Manager": module-manager.md + - "The Module Class": module-class.md + - "The Module Autoloader": module-autoloader.md + - "Best Practices when Creating Modules": best-practices.md +site_name: zend-modulemanager +site_description: zend-modulemanager +repo_url: 'https://github.com/zendframework/zend-modulemanager' +copyright: 'Copyright (c) 2016 Zend Technologies USA Inc.' \ No newline at end of file From 2954984a6e6fe750aff78d51a0a45a0aa6cd74b6 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 22:14:21 +0200 Subject: [PATCH 3/6] [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 0000000..fe84005 --- /dev/null +++ b/doc/book/index.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file From b5de31fbfc0d6471be991f142f5bf2762f82912b Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 22:16:13 +0200 Subject: [PATCH 4/6] [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 0000000..b17ff58 --- /dev/null +++ b/doc/book/index.html @@ -0,0 +1,11 @@ +
+
+

zend-modulemanager

+ +

+ ModuleManager component from Zend Framework +

+ + 
$ composer require zendframework/zend-modulemanager
+
+
\ No newline at end of file From afedf5c415f01684ce75aa3fe79b9878e89997da Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 22:16:41 +0200 Subject: [PATCH 5/6] [Docs] Update .gitignore file --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index a7fc91d..28d2d11 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,8 @@ .*.un~ nbproject tmp/ +doc/html/ +zf-mkdoc-theme/ clover.xml composer.lock From 6a2d4dc1afd7c4983220874d0471a60c8d4ed023 Mon Sep 17 00:00:00 2001 From: froschdesign Date: Fri, 6 May 2016 22:19:24 +0200 Subject: [PATCH 6/6] [Docs] Update .travis.yml file --- .travis.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.travis.yml b/.travis.yml index 3526442..2ba452e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,11 +10,18 @@ branches: cache: directories: - $HOME/.composer/cache + - $HOME/.local + - zf-mkdoc-theme env: global: - EVENT_MANAGER_VERSION="^3.0" - SERVICE_MANAGER_VERSION="^3.0.3" + - SITE_URL: https://zendframework.github.io/zend-modulemanager + - GH_USER_NAME: "Matthew Weier O'Phinney" + - GH_USER_EMAIL: matthew@weierophinney.net + - GH_REF: github.com/zendframework/zend-modulemanager.git + - secure: "" matrix: fast_finish: true @@ -29,6 +36,8 @@ matrix: - php: 5.6 env: - EXECUTE_TEST_COVERALLS=true + - 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: - EVENT_MANAGER_VERSION="^2.6.2" @@ -64,6 +73,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 + +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