Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated to use new theme for docs site #9320

Merged
merged 15 commits into from Oct 27, 2018
@@ -1,94 +1,72 @@
<br />
<br />
<div class="row">
<div class="col-md-4">
<div class="well">
<div class="home-header">
<a href="/Installation/">
<i class="fa fa-download fa-2x"></i>
<span> Installing</span>
</a>
</div>
<br />
<a href="/Installation/Installation-Ubuntu-1804-Nginx/">Ubuntu 18.04 + Nginx</a><br />
<a href="/Installation/Installation-CentOS-7-Nginx/">CentOS 7 + Nginx</a><br />
<a href="/Installation/Migrating-from-Observium/">Migrating from Observium</a><br />
<a href="/Installation/Installing-LibreNMS/"><strong>More...</strong></a>
<div class="home-container">
<div class="home-box">
<div class="home-header">
<a href="/Installation/">
<i class="fa fa-download fa-1x"></i>
<span> Installing</span>
</a>
</div>
<a href="/Installation/">Installing LibreNMS</a><br />
<a href="/Installation/Installation-Ubuntu-1804-Nginx/">Ubuntu 18.04 + Nginx</a><br />
<a href="/Installation/Installation-CentOS-7-Nginx/">CentOS 7 + Nginx</a><br />
<a href="/Installation/Installing-LibreNMS/"><strong>More...</strong></a>
</div>
<div class="col-md-4">
<div class="well">
<div class="home-header">
<i class="fa fa-plug fa-2x"></i>
<span> Setup</span>
</div>
<br />
<a href="/Extensions/Auto-Discovery/">Auto Discovery</a><br />
<a href="/Extensions/Oxidized/">Oxidized</a><br />
<a href="/Extensions/RRDCached/">RRDCached</a><br />
<strong>More...</strong>
<div class="home-box">
<div class="home-header">
<i class="fa fa-plug fa-1x"></i>
<span> Setup</span>
</div>
<a href="/Extensions/Auto-Discovery/">Auto Discovery</a><br />
<a href="/Extensions/Oxidized/">Oxidized</a><br />
<a href="/Extensions/RRDCached/">RRDCached</a><br />
<strong>More...</strong>
</div>
<div class="col-md-4">
<div class="well">
<div class="home-header">
<a href="/Alerting/">
<i class="fa fa-bell fa-2x"></i>
<span> Alerting</span>
</a>
</div>
<br />
<a href="/Alerting/Rules/#rules">Rules</a><br />
<a href="/Alerting/Templates/">Templates</a><br />
<a href="/Alerting/Transports/">Transports</a><br />
<a href="/Alerting/"><strong>More...</strong></a>
<div class="home-box">
<div class="home-header">
<a href="/Alerting/">
<i class="fa fa-bell fa-1x"></i>
<span> Alerting</span>
</a>
</div>
<a href="/Alerting/Rules/#rules">Rules</a><br />
<a href="/Alerting/Templates/">Templates</a><br />
<a href="/Alerting/Transports/">Transports</a><br />
<a href="/Alerting/"><strong>More...</strong></a>
</div>
</div>
<div class="row">
<div class="col-md-4">
<div class="well">
<div class="home-header">
<a href="/API/">
<i class="fa fa-connectdevelop fa-2x"></i>
<span> API</span>
</a>
</div>
<br />
<a href="/API/">Using the API</a><br />
<a href="/API/#endpoint-categories">API Endpoints</a><br />
<br />
<br />
<div class="home-box">
<div class="home-header">
<a href="/API/">
<i class="fa fa-connectdevelop fa-1x"></i>
<span> API</span>
</a>
</div>
<a href="/API/">Using the API</a><br />
<a href="/API/#endpoint-categories">API Endpoints</a><br />
<br />
<br />
</div>
<div class="col-md-4">
<div class="well">
<div class="home-header">
<a href="/Support/">
<i class="fa fa-ambulance fa-2x"></i>
<span> Support</span>
</a>
</div>
<br />
<a href="/Support/FAQ/">FAQ</a><br />
<a href="/Support/Install%20Validation/">Install validation</a><br />
<a href="/Support/Performance/">Performance tweaks</a><br />
<a href="/Support/"><strong>More...</strong></a>
<div class="home-box">
<div class="home-header">
<a href="/Support/">
<i class="fa fa-ambulance fa-1x"></i>
<span> Support</span>
</a>
</div>
<a href="/Support/FAQ/">FAQ</a><br />
<a href="/Support/Install%20Validation/">Install validation</a><br />
<a href="/Support/Performance/">Performance tweaks</a><br />
<a href="/Support/"><strong>More...</strong></a>
</div>
<div class="col-md-4">
<div class="well">
<div class="home-header">
<a href="/Developing/">
<i class="fa fa-code-fork fa-2x"></i>
<span> Developing</span>
</a>
</div>
<br />
<a href="/Developing/Code-Guidelines/">Code Guidelines</a><br />
<a href="/Developing/Validating-Code/">Validating Code</a><br />
<a href="/Developing/Using-Git/">Using Git</a><br />
<a href="/Developing/"><strong>More...</strong></a>
<div class="home-box">
<div class="home-header">
<a href="/Developing/">
<i class="fa fa-code-fork fa-1x"></i>
<span> Developing</span>
</a>
</div>
<a href="/Developing/Code-Guidelines/">Code Guidelines</a><br />
<a href="/Developing/Validating-Code/">Validating Code</a><br />
<a href="/Developing/Using-Git/">Using Git</a><br />
<a href="/Developing/"><strong>More...</strong></a>
</div>
</div>
@@ -1,38 +1,63 @@
body {
background-image:none !important;
}

/* limit the height of dropdown menus */
.dropdown-menu {
max-height: 400px !important;
overflow-x: hidden !important;
}

/* push down the content when the header flows to two lines */
.bs-sidebar {
margin-top: 45px;
}
/* larger logo */
.md-logo>img { width:36px; height:36px }
.md-logo { padding-top: 0; }

/* hide the menu called hidden, used to generate unlinked docs */
#dropdown-hidden {
display: none;
}
/* theme adjustment */
.md-typeset a { color: #2fa4e7; }
.md-hero { background-color: #000000; }
.md-header { background-color: #000000; }
.md-tabs { background-color: #000000; }
.md-nav__link:active, .md-nav__link--active { color: #da223a; }
.md-nav__link:focus, .md-nav__link:hover { color: #da223a; }

/* avoid scrollbar on mobile (default 360px) */
.navbar-collapse {
max-height: 385px;
}

/* size and align the headers on the home screen */
.home-header {
font-size: 1.6em;
font-size: 1.6em;
margin-bottom: 10px;
}
.home-header, .home-header a {
color: #da223a;
text-decoration: none;
}
.home-header i {
vertical-align: middle;
padding-right: 12px;
vertical-align: middle;
padding-right: 12px;
}
.home-header span { vertical-align: middle; }

/* home grid layout */
.home-container {
display: flex;
flex-wrap: wrap;
}

.home-box {
flex-basis: calc(33.33% - 30px);
margin: 10px;
min-width: 200px;
min-height: 200px;

box-sizing: border-box;
padding: 19px;
background-color: #f5f5f5;
border: 1px solid #e3e3e3;
border-radius: 4px;
-webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.05);
box-shadow: inset 0 1px 1px rgba(0,0,0,.05);
}

/* media */
@media only screen and (max-width: 76.1875em) {
html .md-nav--primary .md-nav__title--site { background-color: #000000; }
}
@media only screen and (max-width: 59.9375em) {
.md-nav__source { background-color: #232323; }
.home-container { display: block; }
.home-box {
width: 100%;
margin: 0 0 10px 0;
}
}


@@ -452,6 +452,7 @@ devices:
- { Field: hardware, Type: text, 'Null': true, Extra: '' }
- { Field: features, Type: text, 'Null': true, Extra: '' }
- { Field: location, Type: text, 'Null': true, Extra: '' }
- { Field: location_id, Type: int(11), 'Null': true, Extra: '' }
- { Field: os, Type: varchar(32), 'Null': true, Extra: '' }
- { Field: status, Type: tinyint(1), 'Null': false, Extra: '', Default: '0' }
- { Field: status_reason, Type: varchar(50), 'Null': false, Extra: '' }
@@ -771,12 +772,13 @@ loadbalancer_vservers:
locations:
Columns:
- { Field: id, Type: int(11), 'Null': false, Extra: auto_increment }
- { Field: location, Type: text, 'Null': false, Extra: '' }
- { Field: lat, Type: 'double(10,6)', 'Null': false, Extra: '' }
- { Field: lng, Type: 'double(10,6)', 'Null': false, Extra: '' }
- { Field: location, Type: varchar(255), 'Null': false, Extra: '' }
- { Field: lat, Type: 'double(10,6)', 'Null': true, Extra: '' }
- { Field: lng, Type: 'double(10,6)', 'Null': true, Extra: '' }
- { Field: timestamp, Type: datetime, 'Null': false, Extra: '' }
Indexes:
PRIMARY: { Name: PRIMARY, Columns: [id], Unique: true, Type: BTREE }
locations_location_uindex: { Name: locations_location_uindex, Columns: [location], Unique: true, Type: BTREE }
mac_accounting:
Columns:
- { Field: ma_id, Type: int(11), 'Null': false, Extra: auto_increment }
@@ -858,6 +860,13 @@ mibdefs:
- { Field: last_modified, Type: timestamp, 'Null': false, Extra: 'on update CURRENT_TIMESTAMP', Default: CURRENT_TIMESTAMP }
Indexes:
PRIMARY: { Name: PRIMARY, Columns: [module, mib, object_type], Unique: true, Type: BTREE }
migrations:
Columns:
- { Field: id, Type: 'int(10) unsigned', 'Null': false, Extra: auto_increment }
- { Field: migration, Type: varchar(255), 'Null': false, Extra: '' }
- { Field: batch, Type: int(11), 'Null': false, Extra: '' }
Indexes:
PRIMARY: { Name: PRIMARY, Columns: [id], Unique: true, Type: BTREE }
munin_plugins:
Columns:
- { Field: mplug_id, Type: int(11), 'Null': false, Extra: auto_increment }
@@ -1,24 +1,32 @@
site_name: LibreNMS Docs
docs_dir: doc
theme_dir: 'theme_v2'
theme: null
theme:
name: material
logo: img/librenms.svg
language: en
palette: null
font:
text: 'Roboto'
code: 'Roboto Mono'
feature: null
site_dir: out
site_url: http://docs.librenms.org
markdown_extensions:
- pymdownx.tasklist
- pymdownx.tilde
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css
- librenms.css
extra:
logo: img/librenms.svg
article_nav_top: false
article_nav_bottom: true
site_author: LibreNMS
site_description: LibreNMS user and developer documentation
repo_url: https://github.com/librenms/librenms
repo_url: https://github.com/librenms/librenms/
edit_uri: edit/master/doc
repo_name: GitHub
google_analytics: ['UA-79149977-2', 'docs.librenms.org']
pages:
nav:
- Home: index.md
- 1. General:
- Acknowledgements: General/Acknowledgement.md
@@ -158,26 +166,3 @@ pages:
- Device Notes:
- Intro: Support/Device-Notes/index.md
- Carel pCOweb: Support/Device-Notes/Carel-pCOweb-Devices.md
- hidden:
- Alerting/Old_Templates.md
- API/API-Docs.md
- Installation/Installing-LibreNMS.md
- Extensions/Alerting.md
- Extensions/Email-Alerting.md
- Parsing Port Descriptions: Extensions/Port-Description-Parser.md
- Extensions/InfluxDB.md
- Extensions/Graphite.md
- Extensions/OpenTSDB.md
- Extensions/Prometheus.md
- Extensions/RRDCached-Security.md
- General/Contributing.md
- General/Credits.md
- Installation/Installation-Ubuntu-1404-Nginx.md
- Installation/Installation-Ubuntu-1404-Apache.md
- Installation/Installation-Ubuntu-1404-Lighttpd.md
- Ubuntu 16.04 (Nginx): Installation/Installation-Ubuntu-1604-Nginx.md
- Ubuntu 16.04 (Apache): Installation/Installation-Ubuntu-1604-Apache.md
- Installation/Installation-CentOS-6-Apache-Nginx.md
- Installation/Installation-(Debian-Ubuntu).md
- Installation/Installation-(RHEL-CentOS).md
- Support/Support-New-OS.md
@@ -1,18 +1,16 @@
#!/usr/bin/env bash
GH_REPO="@github.com/librenms-docs/librenms-docs.github.io.git"
FULL_REPO="https://${GH_TOKEN}$GH_REPO"
THEME_REPO="https://github.com/librenms-docs/theme_v2.git"

if [ "$EXECUTE_BUILD_DOCS" != "true" ]; then
echo "Doc build skipped"
exit 0
fi

pip install --user 'jinja2<2.9' mkdocs pymdown-extensions
pip install --user mkdocs mkdocs-material pymdown-extensions

This comment has been minimized.

Copy link
@laf

laf Oct 26, 2018

Author Member

mkdocs-material by default needs mkdocs 1.x, mkdocs that's currently being installed in travis is 0.17.5 so I'm not sure this is going to work

pip install --user git+git://github.com/aleray/mdx_del_ins.git

mkdir -p out

cd out

git init
@@ -22,17 +20,11 @@ git config user.name "librenms-docs"
git config user.email "travis@librenms.org"
git checkout master

cd ../

git clone $THEME_REPO

mkdocs build --clean
mkdocs gh-deploy --config-file ../mkdocs.yml --remote-branch master
build_result=$?

# Only deploy after merging to master
if [ "$build_result" == "0" -a "$TRAVIS_PULL_REQUEST" == "false" -a "$TRAVIS_BRANCH" == "master" ]; then
cd out

touch .
git add -A .
git commit -m "GH-Pages update by travis after $TRAVIS_COMMIT"
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.