turbulenz / boundless.docs

Documentation for the Boundless modding API and service HTTP API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

boundless.docs

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>_

About

Documentation for the Boundless modding API and service HTTP API

License:Creative Commons Zero v1.0 Universal


Languages

Language:Python 76.0%Language:Makefile 22.8%Language:CSS 1.2%