Merge pull request #523 from nuklear-ui/docs

Docs

.gitignore

@@ -1,2 +1,6 @@
 demo/*/*.exe
 demo/*/*.obj
+docs/xml
+docs/build
+docs/src
+*.tmp

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/build/html"]
+	path = docs/build/html
+	url = https://github.com/nuklear-ui/nuklear-ui.github.io

.readthedocs.yml

@@ -0,0 +1,2 @@
+conda:
+    file: docs/environment.yml

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Nuklear
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html

@@ -0,0 +1 @@
+Subproject commit 170a3278dd646aa55df36b39b98b58db132f14e6

docs/environment.yml

@@ -0,0 +1,7 @@
+name: nuklear-docs
+
+channels:
+    - conda-forge
+
+dependencies:
+    - breathe

docs/make_docs.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Safety first
+set -euf -o pipefail
+
+# Determine the docs root directory
+DOCS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+cd $DOCS_DIR
+
+# Run doxygen to generate xml output
+doxygen
+
+# Generate html output via sphinx
+make html
+
+
+
+
+

docs/release_docs.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# Safety first
+set -euf -o pipefail
+
+# Determine the docs root directory
+DOCS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+cd $DOCS_DIR/build/html
+git commit -am '[auto] updating static documentation'
+git push origin master
+
+
+
+

docs/setup_docs.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# Dependencies required to generate documentation
+
+if [[ "$(which pip)" == "" ]]; then
+  echo "Could not find pip, please python pip from your repos"
+  exit 1
+fi
+
+if [[ "$(which doxygen)" == "" ]]; then
+  echo "Could not find doxygen, please doxygen from your repos"
+  exit 1
+fi
+
+pip install sphinx
+pip install breathe
+pip install -e git+git://github.com/nuklear-ui/sphinx-to-github.git#egg=sphinx-to-github

docs/source/api/index.rst

@@ -0,0 +1,9 @@
+
+API Index
+===================================
+
+.. toctree::
+  :maxdepth 3
+
+  reference
+

docs/source/api/reference.rst

@@ -0,0 +1,5 @@
+API Reference
+=============================
+
+.. doxygenindex:: Nuklear
+  :project: nuklear

docs/source/conf.py

@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+#
+# Nuklear documentation build configuration file, created by
+# sphinx-quickstart on Wed Sep 20 04:44:20 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+import subprocess, os
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinxtogithub',
+    'breathe']
+
+
+read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
+
+if read_the_docs_build:
+    subprocess.call('cd ../; doxygen', shell=True)
+
+breathe_projects = {
+    "nuklear":"../xml/",
+}
+
+breathe_domain_by_extension = {
+    "h" : "c",
+}
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Nuklear'
+copyright = u'2017, Micha Mettke'
+author = u'Micha Mettke'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'1.0.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'classic'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Nukleardoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Nuklear.tex', u'Nuklear Documentation',
+     u'Micha Mettke', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'nuklear', u'Nuklear Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Nuklear', u'Nuklear Documentation',
+     author, 'Nuklear', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/source/guides/examples.rst

@@ -0,0 +1,4 @@
+Nuklear Examples
+===================================
+
+A list of examples; brief descriptions of each.

docs/source/guides/walk_throughs.rst

@@ -0,0 +1,6 @@
+Walk Throughs
+==================================
+
+Annotated indepth guides that take you through building a real example.
+Covering various topics, from beginner to advance.
+

docs/source/index.rst

@@ -0,0 +1,35 @@
+.. Nuklear documentation master file
+
+Nuklear
+===================================
+
+This is a minimal state immediate mode graphical user interface toolkit written in ANSI C and licensed under public domain.
+
+It was designed as a simple embeddable user interface for application and does not have any dependencies, a default renderbackend or OS window and input handling but instead provides a very modular library approach by using simple input state for input and draw commands describing primitive shapes as output.
+
+Rather than provide a layered library that tries to abstract over a number of platform and render backends, Nuklear only focuses on the actual UI.
+
+Overview
+========================
+
+.. toctree::
+
+  overview/architecture
+  overview/best_practices
+  overview/getting_started
+
+Learn
+========================
+
+.. toctree::
+
+  guides/walk_throughs
+  guides/examples
+
+API Documentation
+========================
+.. toctree::
+  :maxdepth 3
+
+  api/reference
+

docs/source/overview/architecture.rst

@@ -0,0 +1,4 @@
+Architecture Overview
+===================================
+
+UI Concepts, Backend Agnostic ...

docs/source/overview/best_practices.rst

@@ -0,0 +1,4 @@
+Best Practices
+======================
+
+...

docs/source/overview/getting_started.rst

@@ -0,0 +1,2 @@
+Getting Started
+===================================