Skip to content

Commit

Permalink
First commit of assorted docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SkySom committed Sep 10, 2018
1 parent 6cb9d2b commit 29e4203
Show file tree
Hide file tree
Showing 13 changed files with 319 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#Python
/venv/

#Rst
_build/
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = Project
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)
159 changes: 159 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- 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('.'))


# -- Project information -----------------------------------------------------

project = u'Project'
copyright = u'2018, Brass Goggled Coders, Coders After Dark, Miner Arcana, Team Acronym Coders'
author = u'Brass Goggled Coders, Coders After Dark, Miner Arcana, Team Acronym Coders'

# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
release = u''

# -- 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.todo',
'sphinx.ext.autodoc'
]

# 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'

# 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 pattern also affects html_static_path and html_extra_path .
exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# -- 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 = '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']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'Projectdoc'

# -- 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, 'Project.tex', u'Project Documentation',
u'Brass Goggled Coders, Coders After Dark, Miner Arcana, Team Acronym Coders', '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, 'project', u'Project 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, 'Project', u'Project Documentation',
author, 'Project', 'One line description of project.',
'Miscellaneous'),
]

# -- Extension configuration -------------------------------------------------

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
18 changes: 18 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Welcome to Project's documentation!
===================================

.. toctree::
:maxdepth: 2
:caption: Contents:

/mods/index
/systems/index




Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
36 changes: 36 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=Project

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%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
8 changes: 8 additions & 0 deletions docs/mods/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Mods
====

.. toctree::
:maxdepth: 2
:caption: Contents:

/mods/reskillable/index
8 changes: 8 additions & 0 deletions docs/mods/reskillable/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Reskillable
===========

.. toctree::
:maxdepth: 2
:caption: Contents:

/mods/reskillable/requirements/index
2 changes: 2 additions & 0 deletions docs/mods/reskillable/requirements/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Requirements
============
7 changes: 7 additions & 0 deletions docs/systems/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Systems
=======

.. toctree::
:maxdepth: 2

/systems/recipe/index
9 changes: 9 additions & 0 deletions docs/systems/recipe/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Recipe System
=============

.. toctree::
:maxdepth: 2
:caption: Contents:

/systems/recipe/intro
/systems/recipe/inputs/index
36 changes: 36 additions & 0 deletions docs/systems/recipe/inputs/blockstate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
BlockState
==========

Break Down:
-----------

The Blockstate input is comprised of two section, one required: blockState, and one optional: offset.

The blockstate has one required field: block which must match a valid block, and then one optional field:
properties which is an object containing valid blockstate properties. (Note that missing properties will be considered
as all properties matching.)

The offset is optional, and all three of it's fields (x, y, and z) are all optionals and default to zero, this offset is
a location different from the block that is handling the current recipe

Example:
--------

.. code-block:: json
{
"type": "base:blockstate",
"blockState": {
"block": "minecraft:stone",
"properties": {
"variant": [
"granite"
]
}
},
"offset": {
"x": 0,
"y": 1,
"z": 0
}
}
8 changes: 8 additions & 0 deletions docs/systems/recipe/inputs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Inputs
======

.. toctree::
:maxdepth: 2
:caption: Contents:

/systems/recipe/inputs/blockstate
3 changes: 3 additions & 0 deletions docs/systems/recipe/intro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Intro to Recipe System
======================

0 comments on commit 29e4203

Please sign in to comment.