Documentation for the Boundless modding API and service HTTP API
Building the documentation requires:
pip install sphinx recommonmark sphinx_markdown_tables make
Pages can be .rst
reStructuredText or .md
markdown. Use reStructuredText for more complicated pages and API documentation. Optionally use markdown for simple pages or anything that will be posted to the forum. Learning markup:
Sphinx reStructuredText Primer <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections>
_Common Markdown Primer <https://commonmark.org/help/>
_Github Markdown Primer <https://guides.github.com/features/mastering-markdown/>
_Sphinx Docs <http://www.sphinx-doc.org/en/master/>
_Alabaster Theme <https://alabaster.readthedocs.io/en/latest/index.html>
_Python Style Guide <https://devguide.python.org/documenting/#style-guide>
_reStructuredText Primer <https://docutils.sourceforge.io/rst.html>
_