Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.01 KB

File metadata and controls

24 lines (17 loc) · 1.01 KB

myArmy Documentation

This is the documentation for myArmy (http://myarmy.umulmrum.de). myArmy is a tabletop army creation tool which is completely browser-based and can be used online and offline.

License

This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. Contributing is highly welcome. By contributing you agree to license your work under the same Creative Commons license.

Installation

  1. Clone this repository
  2. Clone the bootstrap theme from https://github.com/ryan-roemer/sphinx-bootstrap-theme.git into a directory outside this project.
  3. There is a symlink from "_themes/bootstrap" to "../../sphinx-theme/sphinx-bootstrap-theme/sphinx-bootstrap-theme/bootstrap/". If this link doesn't fit your needs or your operating system, adjust it accordingly.
  4. Install Sphinx (Ubuntu: python-sphinx package)

Build documentation

In this project's root, call "make html" to create the HTML documentation.