Add files via upload

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)

about/contact.rst

@@ -0,0 +1,4 @@
+Contact Us
+===========
+
+You can reach us on our `Discord <https://discord.gg/qfZVTbNkMg>`_.

about/faq.rst

@@ -0,0 +1,20 @@
+Frequently Asked Questions
+===========================
+
+General
+********
+
+What is Podrum?
+----------------
+
+Podrum is a Minecraft Bedrock Edition server software written in Python.
+
+What do I need to run it?
+--------------------------
+
+Podrum requires python 3.6+, however, we recommend you use the latest version.
+
+Where do I get it?
+-------------------
+
+You can view a tutorial on downloading Podrum :ref:`here<server_index>`.

about/index.rst

@@ -0,0 +1,12 @@
+About Podrum
+=============
+
+This section provides basic information about the project.
+
+.. toctree::
+    :maxdepth: 2
+    :titlesonly:
+
+    introduction
+    faq
+    contact

about/introduction.rst

@@ -0,0 +1,13 @@
+Introduction
+=============
+
+Podrum is a Minecraft Bedrock Edition server software written in Python.
+
+It was made to provide an easy way for Python developers to
+create a server for the Minecraft: Bedrock Edition.
+
+Where can I download Podrum?
+*****************************
+
+You can view a tutorial on downloading Podrum :ref:`here<server_index>`.
+

conf.py

@@ -0,0 +1,60 @@
+# 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 = 'Podrum'
+copyright = '2021, Podrum Team'
+author = 'Podrum Team'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.6'
+
+# -- 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",
+    "sphinx.ext.intersphinx"
+]
+
+# 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']
+
+# -- Template Options --------------------------------------------------------
+
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
+
+# -- 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']

index.rst

@@ -0,0 +1,67 @@
+.. Podrum documentation master file, created by
+   sphinx-quickstart on Tue Jul  6 11:42:36 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Podrum
+==================================
+
+A Minecraft Bedrock Edition server software written in Python.
+It's still under active development, yet it has a few advantages:
+
+1. Easy to use,
+
+2. Written in Python which makes plugins easier to write.
+
+.. warning::
+   This software and documentation is in active development,
+   many things will be subject to change.
+
+Features
+*********
+
+- World Generation
+- Networking
+- Commands
+- MOTD
+- Joinable
+- Plugin API
+- Mobs (coming soon)
+
+Running a Podrum Server
+************************
+
+Running a Podrum server is simple.
+This section will cover common tasks such as configuring it,
+maintaining plugins, amongst other things.
+
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+
+    server/index
+
+Creating Plugins
+*****************
+
+Creating plugins is fairly straighforward.
+This section will explain the process of creating a plugin.
+
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+
+    plugins/index
+
+About Podrum
+*************
+
+Podrum is a Minecraft Bedrock Edition server software written in Python.
+The following links will explain more about this project.
+
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+
+    about/index
+

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