home-assistant.github.io/faq/documentation-tool/index.html
2018-02-13 08:59:03 +00:00

182 lines
8.3 KiB
HTML

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Documentation tools - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Tools for creating the documentation">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/faq/documentation-tool/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Documentation tools">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/faq/documentation-tool/">
<meta property="og:type" content="article">
<meta property="og:description" content="Tools for creating the documentation">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Documentation tools">
<meta name="twitter:description" content="Tools for creating the documentation">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_faq/documentation-tool.markdown'>Edit this page on GitHub</a></div>
<header>
<h1 class="title indent">
Documentation tools
</h1>
</header>
<hr class="divider">
<p>Why are you not using tools X for the documentation? Because the current solution works for us and we see no additional value in using a separate publishing platform.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='section'>
<h1 class="title delta">Entries</h1>
<ul class='divided sidebar-menu'>
<li>
<b>Common</b>
<ul>
<li><a href='/faq#python-2'>Python 2</a></li>
<li><a href='/faq#releases'>Releases</a></li>
</ul>
</li>
<li>
<b>Configuration</b>
<ul>
<li><a href='/faq#my-component-does-not-show-up'>My component does not show up</a></li>
<li><a href='/faq#why-are-you-using-yaml-for-the-configuration-file'>Why are you using YAML for the configuration file?</a></li>
</ul>
</li>
<li>
<b>Documentation</b>
<ul>
<li><a href='/faq#documentation-tools'>Documentation tools</a></li>
<li><a href='/faq#missing-documentation'>Missing Documentation</a></li>
</ul>
</li>
<li>
<b>Installation</b>
<ul>
<li><a href='/faq#home-assistant-vs-hass-io'>Home Assistant vs. Hass.io</a></li>
<li><a href='/faq#no-module-named-pip'>No module named pip</a></li>
<li><a href='/faq#distutils-errors-distutilsoptionerror'>distutils.errors.DistutilsOptionError</a></li>
<li><a href='/faq#libyaml-is-not-found-or-a-compiler-error'>libyaml is not found or a compiler error</a></li>
<li><a href='/faq#pip3-command-not-found'>pip3: command not found</a></li>
</ul>
</li>
<li>
<b>Usage</b>
<ul>
<li><a href='/faq#after-upgrading-your-browser-login-gets-stuck'>After upgrading, your browser login gets stuck</a></li>
<li><a href='/faq#connection-error'>Connection error</a></li>
<li><a href='/faq#dependencies'>Dependencies</a></li>
<li><a href='/faq#frontend-is-acting-weird'>Frontend is acting weird</a></li>
<li><a href='/faq#problems-with-dependencies'>Problems with dependencies</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>