Skip to content

Commit

Permalink
New documentation in reST
Browse files Browse the repository at this point in the history
  • Loading branch information
CurlyMoo committed Sep 16, 2017
1 parent bbc388b commit 5d38117
Show file tree
Hide file tree
Showing 54 changed files with 11,555 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -46,3 +46,6 @@ pilight-uuid
._*
ehthumbs.db
Thumbs.db

# docs
docs/build
36 changes: 36 additions & 0 deletions docs/make.bat
@@ -0,0 +1,36 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=pilight

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
Binary file added docs/source/.static/Roboto-Condensed.woff
Binary file not shown.
Binary file added docs/source/.static/Roboto-Condensed.woff2
Binary file not shown.
105 changes: 105 additions & 0 deletions docs/source/.static/custom.css
@@ -0,0 +1,105 @@
body,
h1, h2, h3,
h4, h5, h6,
dt, dl, dd,
blockquote,
td, th, div,
ul, li, ol,
a, p, input,
div.sphinxsidebar .sidebar-toc a,
.sidebar-block h2,
.text-logo,
.admonition-title {
font-family:'Roboto Condensed', sans-serif
}

div.sphinxsidebar {
margin-top: 5px;
padding-top: 80px;
background: url('pilight.png') no-repeat top center;
}

.text-logo {
display: none;
}

blockquote {
background: transparent;
border: 0px;
}

table.docutils {
border: 0px solid transparent;
width: 100%;
text-align: center;
}

table.docutils * {
border: 0px solid transparent;
background: none;
}

div[class^='highlight'] {
overflow-x: auto;
margin: 1px 0 24px 0
}

div[class^='highlight'] div[class^='highlight'] {
margin: 0;
padding: 0;
}

table {
border-collapse: collapse;
margin: 0px;
padding: 0px;
}

.highlighttable pre {
margin: 0px;
padding: 0px;
}

.event-success,
.event-fail {
position: relative;
float: right;
font-size: 16px;
padding: 0px;
margin-top: 2px;
width: 60px;
display: block;
}

.event-success {
color: green;
}

.event-fail {
color: red;
}

.text-logo {
background: #fafafa;
}

.sidebar-toc ul li a:hover {
background-color: white;
color: red;
}

.sidebar-toc ul li.current > a,
.sidebar-toc ul li.current > a:hover {
background-color: #ffcc00;
color: #444;
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: hidden;
}
1 change: 1 addition & 0 deletions docs/source/.static/font.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions docs/source/about_manual.rst
@@ -0,0 +1,12 @@
About manual
============

The pilight manual is a community driven project open for everyone to participate in. The goal is to provide a multi-lingual and professional software manual for each pilight release. All users are invited to add, edit, or replace content to their best effort. If you want to contribute then also add your name in the contributor list below.

The pilight manual is consists of various so called RestructuredText documents.

These individual documents are then combined into a master document. The master documents are converted into the final pilight manual using Sphinx

Contributors:

CurlyMo, pilino1234, wo_rasp

0 comments on commit 5d38117

Please sign in to comment.