Merge pull request #4120 from laf/new-docs

Ready for new docs site

.travis.yml

@@ -3,17 +3,30 @@ matrix:
   fast_finish: true
   include:
   - php: 7.0
-    env: PHP_L=1
+    env:
+      PHP_L=1
+      EXECUTE_BUILD_DOCS=false
   - php: 5.3
-    env: PHP_L_OLD=1
+    env:
+      PHP_L_OLD=1
+      EXECUTE_BUILD_DOCS=false
   - php: 5.4
-    env: PHP_L_OLD=1
+    env:
+      PHP_L_OLD=1
+      EXECUTE_BUILD_DOCS=false
   - php: 5.5
-    env: PHP_L=1
+    env:
+      PHP_L=1
+      EXECUTE_BUILD_DOCS=false
   - php: 5.6
-    env: PHP_L=1 PHPCS=0
+    env:
+      PHP_L=1
+      PHPCS=0
+      EXECUTE_BUILD_DOCS=true
   - php: hhvm
-    env: PHP_L_OLD=1
+    env:
+      PHP_L_OLD=1
+      EXECUTE_BUILD_DOCS=false
 
   allow_failures:
   - php: 7.0
@@ -27,6 +40,10 @@ cache:
 before_script:
   - composer install --prefer-dist --no-interaction
 
+after_success:
+  - test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && test $EXECUTE_BUILD_DOCS == "true" && bash scripts/deploy-docs.sh
+
+
 script:
   - if [[ $PHP_L == 1 ]]; then find . -path './vendor' -prune -o -name "*.php" -print0 | xargs -0 -n1 -P8 php -l | grep -v '^No syntax errors detected' ; test $? -eq 1; fi
   - if [[ $PHP_L_OLD == 1 ]]; then find . -regextype posix-extended -regex "\./(lib/influxdb-php|vendor)" -prune -o -name "*.php" -print0 | xargs -0 -n1 -P8 php -l | grep -v '^No syntax errors detected' ; test $? -eq 1; fi

doc/index.md

@@ -1 +1,14 @@
-# Welcome to the documentation for [LibreNMS](https://github.com/librenms/librenms)
+### Welcome to the LibreNMS docs
+
+Some of these docs are work in progress or may be missing configuration examples for varying distros.
+If you find this is the case then please feel free to edit them on [GitHub](https://github.com/librenms/librenms/tree/master/doc)
+and submit a pull request.
+
+The docs should provide you with information on various elements to the software:
+
+  - Installation
+  - Support / FAQ
+  - Developing for LibreNMS
+  - Available extensions
+
+

doc/librenms.css

@@ -0,0 +1,9 @@
+body {
+    background-image:none !important;
+}
+
+.dropdown-menu {
+    max-height: 400px !important;
+    overflow-x: hidden !important;
+}
+

mkdocs.yml

@@ -0,0 +1,14 @@
+site_name: LibreNMS Documentation
+theme: mkdocs
+docs_dir: doc
+site_dir: out
+site_url: http://docs.librenms.org
+markdown_extensions:
+    - pymdownx.superfences
+extra_css:
+    - librenms.css
+include_next_prev: false
+site_author: LibreNMS
+site_description: LibreNMS user and developer documentation
+repo_url: https://github.com/librenms/librenms
+repo_name: GitHub

scripts/deploy-docs.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+GH_REPO="@github.com/librenms/docs.librenms.org.git"
+FULL_REPO="https://${GH_TOKEN}$GH_REPO"
+
+pip install --user mkdocs
+pip install --user pymdown-extensions
+
+mkdir -p out
+
+cd out
+
+git init
+git remote add origin $FULL_REPO
+git fetch
+git config user.name "docs-build"
+git config user.email "travis@librenms.org"
+git checkout gh-pages
+
+cd ../
+
+mkdocs build --clean
+
+cd out
+
+touch .
+git add -A .
+git commit -m "GH-Pages update by travis after $TRAVIS_COMMIT"
+git push -q origin gh-pages