Skip to content

Commit 5e86fa2

Browse files
russkevrusskev
committed
Added docs folder
1 parent 1b35684 commit 5e86fa2

File tree

16 files changed

+2741
-11
lines changed

16 files changed

+2741
-11
lines changed

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ advanced real time lighting features.
3636
- Screen space ambient occlusion
3737
- Glow effect
3838

39+
# Libraries used
40+
- [OpenGL Extension Wrangler Library (GLEW)](http://glew.sourceforge.net/) f
41+
- [OpenGL Mathematics (GLM)](https://go.grottel.net/nuget-project/glm) for vector and matrix operations.
42+
- [SDL2](https://www.libsdl.org/index.php) for input / output operations.
43+
3944
# Screenshots
4045
![Demo 01](assets/screenshots/demo_01.jpg)
4146
![Demo 02](assets/screenshots/demo_02.jpg)

‎docs/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
_build/
2+
_static/
3+
_templates/

‎docs/Doxyfile.in‎

Lines changed: 2513 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Steps to make documentation
2+
3+
- To start fresh, first delete the `_build` directory
4+
- Load Msys in this `docs_sphinx` folder
5+
- run `doxygen Doxyfile.in`
6+
- Whis will generate the doxygen documentation
7+
- run `make html`
8+
- This will make the Sphinx documantation
9+

‎docs/api/gl_engine.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _api_camera:
2+
3+
GL Engine
4+
=========
5+
.. doxygenindex::
6+
:project: GL Engine

‎docs/api/index.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
..
2+
_api:
3+
4+
API
5+
===
6+
.. toctree::
7+
:maxdepth: 2
8+
:glob:
9+
10+
*

‎docs/conf.py‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
# import os
14+
# import sys
15+
# sys.path.insert(0, os.path.abspath('.'))
16+
from sphinx.builders.html import StandaloneHTMLBuilder
17+
import subprocess, os
18+
19+
20+
# read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
21+
22+
# if read_the_docs_build:
23+
24+
# subprocess.call('doxygen Doxyfile.in', shell=True)
25+
26+
subprocess.call('doxygen Doxyfile.in', shell=True)
27+
28+
# -- Project information -----------------------------------------------------
29+
30+
project = 'GL Engine'
31+
copyright = '2020, Kevin Russell'
32+
author = 'Kevin Russell'
33+
34+
# The full version, including alpha/beta/rc tags
35+
release = 'v0.1'
36+
37+
38+
# -- General configuration ---------------------------------------------------
39+
40+
# Add any Sphinx extension module names here, as strings. They can be
41+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42+
# ones.
43+
extensions = [
44+
'sphinx.ext.autodoc',
45+
'sphinx.ext.intersphinx',
46+
'sphinx.ext.autosectionlabel',
47+
'sphinx.ext.todo',
48+
'sphinx.ext.coverage',
49+
'sphinx.ext.mathjax',
50+
'sphinx.ext.ifconfig',
51+
'sphinx.ext.viewcode',
52+
'sphinx_sitemap',
53+
'sphinx.ext.inheritance_diagram',
54+
'breathe'
55+
]
56+
57+
# Add any paths that contain templates here, relative to this directory.
58+
templates_path = ['_templates']
59+
60+
# List of patterns, relative to source directory, that match files and
61+
# directories to ignore when looking for source files.
62+
# This pattern also affects html_static_path and html_extra_path.
63+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
64+
65+
highlight_language = 'c++'
66+
67+
# -- Options for HTML output -------------------------------------------------
68+
69+
# The theme to use for HTML and HTML Help pages. See the documentation for
70+
# a list of builtin themes.
71+
#
72+
html_theme = 'sphinx_rtd_theme'
73+
html_theme_options = {
74+
'canonical_url': '',
75+
'analytics_id': '',
76+
'display_version': True,
77+
'prev_next_buttons_location': 'bottom',
78+
'style_external_links': False,
79+
80+
'logo_only': False,
81+
82+
# Toc options
83+
'collapse_navigation': True,
84+
'sticky_navigation': True,
85+
'navigation_depth': 4,
86+
'includehidden': True,
87+
'titles_only': False
88+
}
89+
# html_logo = ''
90+
# github_url = ''
91+
# html_baseurl = ''
92+
93+
# Add any paths that contain custom static files (such as style sheets) here,
94+
# relative to this directory. They are copied after the builtin static files,
95+
# so a file named "default.css" will overwrite the builtin "default.css".
96+
html_static_path = ['_static']
97+
98+
99+
# -- Breathe configuration -------------------------------------------------
100+
101+
breathe_projects = {
102+
"GL Engine": "_build/xml/"
103+
}
104+
breathe_default_project = "GL Engine"
105+
breathe_default_members = ('members', 'undoc-members')

‎docs/index.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. GL Engine documentation master file, created by
2+
sphinx-quickstart on Mon Dec 7 17:17:11 2020.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to GL Engine's documentation!
7+
=====================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`
21+
22+
Table of Contents
23+
^^^^^^^^^^^^^^^^^
24+
25+
.. toctree::
26+
:maxdepth: 2
27+
28+
self
29+
api/index

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

0 commit comments

Comments
 (0)