Move most of our docs into the 'docs' directory as we being Read The Docs setup

pull/783/head
Jesse Vincent 5 years ago
parent 2e78110991
commit a60651054a
No known key found for this signature in database
GPG Key ID: CC228463465E40BC

5
.gitignore vendored

@ -2,7 +2,4 @@
.#*
/output/
/examples/*/output/
docs/_build
docs/doxyoutput
docs/api
/out/

@ -3,10 +3,10 @@
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXOPTS ?= -c ../etc/docs
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
BUILDDIR = ../out/docs
# Put it first so that "make" without argument is like "make help".
help:

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 89 KiB

@ -15,6 +15,61 @@ Welcome to Kaleidoscope's documentation!
:caption: Contents:
Supported input devices
=======================
.. toctree::
:maxdepth: 2
:glob:
hardware-devices/*
Plugins
=======
.. toctree::
:maxdepth: 1
:glob:
plugins/*
For developers
==============
.. toctree::
:maxdepth: 1
codebase/glossary.md
codebase/code-style.md
API Design docs
===============
.. toctree::
maxdepth: 1
:glob:
api-reference/*
Device drivers
==============
.. toctree::
:maxdepth: 2
:glob:
drivers/**
Upgrading from old versions
===========================
.. toctree::
:maxdepth: 2
UPGRADING.md
Indices and tables
==================

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
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% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

@ -62,6 +62,13 @@ primary_domain = 'cpp'
# Tell sphinx what the pygments highlight language should be.
highlight_language = 'cpp'
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'restructuredtext',
}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -69,7 +76,7 @@ templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'etc']
# -- Options for HTML output -------------------------------------------------
Loading…
Cancel
Save