diff --git a/api-docs/drawing model.ipynb b/api-docs/drawing model.ipynb new file mode 100644 index 0000000..5212d86 --- /dev/null +++ b/api-docs/drawing model.ipynb @@ -0,0 +1,45 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Drawing Model" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Bots are renderered in three stages:\n", + "\n", + "The [script](scripting.ipynb) makes calls to the user API.\n", + "\n", + "The [user API](user-api.ipynb) calls add nodes to the Scene Graph\n", + "\n", + "The [renderer](renderer.ipynb) traverses the scene graph and outputs the an image or vector to the target." + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.6.8" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/api-docs/index.ipynb b/api-docs/index.ipynb new file mode 100644 index 0000000..9f2dc94 --- /dev/null +++ b/api-docs/index.ipynb @@ -0,0 +1,42 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "API Documentation\n", + "==\n", + "\n", + "The API is documented using Jupyter Notebooks to demonstrate it." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "[Drawing Model](drawing%20model.ipynb)" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.6.8" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/api-docs/renderer.ipynb b/api-docs/renderer.ipynb new file mode 100644 index 0000000..59a7d62 --- /dev/null +++ b/api-docs/renderer.ipynb @@ -0,0 +1,44 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Renderers\n", + "==\n", + "\n", + "Renderers are the final stage of output the data from the scenegraph to the target." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Console Renderer\n", + "\n", + "The console renderer outputs every node from the scenegraph to the console." + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.6.8" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/api-docs/scripting.ipynb b/api-docs/scripting.ipynb new file mode 100644 index 0000000..4ed830c --- /dev/null +++ b/api-docs/scripting.ipynb @@ -0,0 +1,34 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Scripting" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.6.8" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +}