From 2441278a66412f89f3d8dc4c5dc83c4ef2572629 Mon Sep 17 00:00:00 2001 From: Gede Hari Date: Sun, 12 Sep 2021 13:20:50 +0800 Subject: [PATCH] Read The Docs setup --- .gitignore | 3 +- docs/Makefile | 20 ++++++++++ docs/about/introduction.rst | 2 + docs/conf.py | 55 ++++++++++++++++++++++++++++ docs/index.rst | 26 +++++++++++++ docs/make.bat | 35 ++++++++++++++++++ docs/tutorials/1-getting-started.rst | 7 ++++ 7 files changed, 147 insertions(+), 1 deletion(-) create mode 100644 docs/Makefile create mode 100644 docs/about/introduction.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100644 docs/tutorials/1-getting-started.rst diff --git a/.gitignore b/.gitignore index d08c56b9d..62b86305a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ export/ .vscode/ APIStuff.hx -mods/ \ No newline at end of file +mods/ +docs/_build \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..d4bb2cbb9 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +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) diff --git a/docs/about/introduction.rst b/docs/about/introduction.rst new file mode 100644 index 000000000..c516b3317 --- /dev/null +++ b/docs/about/introduction.rst @@ -0,0 +1,2 @@ +Introduction +============ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..b33929c43 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,55 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# 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('.')) + +import sphinx_rtd_theme + + +# -- Project information ----------------------------------------------------- + +project = 'Forever Engine Documentation' +copyright = '2021, Yoshubs, gedehari, and contributors' +author = 'Yoshubs, gedehari, and contributors' + + +# -- General configuration --------------------------------------------------- + +# 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_rtd_theme" +] + +# Add any paths that contain templates here, relative to this directory. +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'] + + +# -- 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 = 'sphinx_rtd_theme' + +# 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'] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..48a3e1047 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,26 @@ +Welcome to Forever Engine's documentation! +========================================== +This site will document Forever Engine's features and documentation of said features, +as well as document differences to other engines. +We hope you learn something new! + + +.. toctree:: + :maxdepth: 1 + :caption: Introduction + + about/introduction + +.. toctree:: + :maxdepth: 1 + :caption: Tutorials + + tutorials/1-getting-started + + +.. Indices and tables +.. ================== + +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..922152e96 --- /dev/null +++ b/docs/make.bat @@ -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 diff --git a/docs/tutorials/1-getting-started.rst b/docs/tutorials/1-getting-started.rst new file mode 100644 index 000000000..ec72fba4e --- /dev/null +++ b/docs/tutorials/1-getting-started.rst @@ -0,0 +1,7 @@ +\1. Getting Started +=================== +This page will teach you on how to get Forever Engine up and running. + +Installing +---------- +none \ No newline at end of file