Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 969 Bytes

README.md

File metadata and controls

18 lines (13 loc) · 969 Bytes

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