reilleya / openMotor

An open-source internal ballistics simulator for rocket motor experimenters
GNU General Public License v3.0
398 stars 78 forks source link

Feature/sphinx docs #100

Closed quigleyj97 closed 5 years ago

quigleyj97 commented 5 years ago

This adds documentation using the Sphinx doc generator, including both reference docs for motorlib and a short doc on building.

image

This will give us a base to build off for further user docs, such as how-tos, a getting started guide, examples, tutorials, etc.

To build the docs, install Sphinx:

$ pip install sphinx
$ cd ./docs
$ sphinx--build -b html . _build

You can also use make html on *nix or make.bat html on Windows, once you have sphinx installed.

The generated docs will be in ./docs/_build/index.html and can be browsed using a normal web browser.

reilleya commented 5 years ago

Looks good to me. Think we should have something about the docs in the main readme?