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 diff --git a/.travis.yml b/.travis.yml index 73f4c14..dd841ba 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,6 +10,16 @@ branches: cache: directories: - $HOME/.composer/cache + - $HOME/.local + - zf-mkdoc-theme + +env: + global: + - SITE_URL: https://zendframework.github.io/zend-memory + - GH_USER_NAME: "Matthew Weier O'Phinney" + - GH_USER_EMAIL: matthew@weierophinney.net + - GH_REF: github.com/zendframework/zend-memory.git + - secure: "" matrix: fast_finish: true @@ -20,6 +30,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: 7 - php: hhvm allow_failures: @@ -42,6 +54,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/index.html b/doc/book/index.html new file mode 100644 index 0000000..651d76f --- /dev/null +++ b/doc/book/index.html @@ -0,0 +1,12 @@ +
+
+

zend-memory

+ +

+ The Zend\Memory component is intended to manage data in an + environment with limited memory. +

+ +
$ composer require zendframework/zend-memory
+
+
\ No newline at end of file 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 diff --git a/doc/book/zend.memory.overview.md b/doc/book/intro.md similarity index 100% rename from doc/book/zend.memory.overview.md rename to doc/book/intro.md diff --git a/doc/book/zend.memory.memory-manager.md b/doc/book/memory-manager.md similarity index 100% rename from doc/book/zend.memory.memory-manager.md rename to doc/book/memory-manager.md diff --git a/doc/book/zend.memory.memory-objects.md b/doc/book/memory-objects.md similarity index 100% rename from doc/book/zend.memory.memory-objects.md rename to doc/book/memory-objects.md diff --git a/doc/bookdown.json b/doc/bookdown.json deleted file mode 100644 index ffb6811..0000000 --- a/doc/bookdown.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "title": "Zend\\Memory", - "target": "html/", - "content": [ - "book/zend.memory.overview.md", - "book/zend.memory.memory-manager.md", - "book/zend.memory.memory-objects.md" - ] -} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..394591b --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,12 @@ +docs_dir: doc/book +site_dir: doc/html +pages: + - index.md + - Intro: intro.md + - Reference: + - "Memory Manager": module-manager.md + - "Memory Objects": module-class.md +site_name: zend-memory +site_description: zend-memory +repo_url: 'https://github.com/zendframework/zend-memory' +copyright: 'Copyright (c) 2016 Zend Technologies USA Inc.' \ No newline at end of file