Add doxygen for C

CMakeLists.txt

@@ -2,6 +2,8 @@ cmake_minimum_required(VERSION 2.8)
 
 project(craft)
 
+add_subdirectory(doc)
+
 FILE(GLOB SOURCE_FILES src/*.c)
 
 add_executable(

README.md

@@ -39,6 +39,11 @@ the installation:
     sudo apt-get install cmake libglew-dev xorg-dev libcurl4-openssl-dev
     sudo apt-get build-dep glfw
 
+Docs:
+
+    sudo pip install sphinx
+    sudo apt-get install doxygen python-breathe
+
 #### Windows
 
 Download and install [CMake](http://www.cmake.org/cmake/resources/software.html)
@@ -62,6 +67,8 @@ terminal.
     cmake .
     make
     ./craft
+    # For docs
+    make doc-all|doc-man|doc-html|doc-tex # Craft/doc/sphinx/build
 
 ### Multiplayer
 

doc/.gitignore

@@ -0,0 +1,17 @@
+xml
+sphinx
+
+# Created by https://www.gitignore.io/api/cmake
+
+### CMake ###
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Testing
+Makefile
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+
+# End of https://www.gitignore.io/api/cmake

doc/CMakeLists.txt

@@ -0,0 +1,31 @@
+project(craft)
+
+macro(add_sphinx_target TARGET_NAME BUILDER COMMENT_STR)
+  add_custom_target(${TARGET_NAME}
+    COMMAND sphinx-build -b ${BUILDER} . sphinx/build/${BUILDER}
+    DEPENDS doxygen
+    COMMENT ${COMMENT_STR})
+endmacro(add_sphinx_target)
+
+add_custom_target(doxygen
+  COMMAND doxygen doxygen.conf
+  COMMENT "Build doxygen xml files used by sphinx/breathe.")
+
+add_sphinx_target(doc-html
+  html
+  "Build html documentation")
+
+add_sphinx_target(doc-man
+  man
+  "Build MAN pages")
+
+add_sphinx_target(doc-tex
+  latex
+  "Build PDF documentation")
+
+add_custom_target(doc-all
+  DEPENDS doc-html doc-man doc-tex)
+
+install(FILES
+  ${CMAKE_CURRENT_BINARY_DIR}/sphinx/build/man/craft.1
+  DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man1)

doc/conf.py

@@ -0,0 +1,169 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Craft documentation build configuration file, created by
+# sphinx-quickstart on Thu Jun  1 17:19:32 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'
+
+# 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.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.githubpages',
+    'breathe']
+
+breathe_domain_by_extension = {'h': 'c'}
+
+# Breathe doxygen xml path
+breathe_projects = {
+    'Craft': 'xml'
+}
+
+# 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 = 'Craft'
+author = 'fogleman'
+
+# 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 = '0.0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.0.1'
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+# 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' #'alabaster'
+
+# 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 = 'Craftdoc'
+
+
+# -- 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, 'Craft.tex', 'Craft Documentation',
+     'fogleman', '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, 'craft', 'Craft 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, 'Craft', 'Craft Documentation',
+     author, 'Craft', 'A simple Minecraft clone written in C using modern OpenGL (shaders). ',
+     'Miscellaneous'),
+]
+
+
+