search

cuspaceflight / firefish

CFD simulation software for Martlet 3
Apache License 2.0
5 stars 4 forks source link

add sphinx documentation #8

Closed rjw57 closed 8 years ago

rjw57 commented 8 years ago

The sphinx documentation system is, as noted in #7, a standard system for generating Python documentation. Currently I have http://cusfsim.readthedocs.org/ set up to generate documentation from my local fork but if the PR is merged, I'll move it over to the main cuspaceflight fork.

This PR adds the minimal configuration to get sphinx up and running and adds a test environment for it along with travis configuration. It includes some simple reference documentation.

Once merged I'll propose a PR which has some more complex documentation.

Closes #7.

rjw57 commented 8 years ago

@boyuanxiao, I'll take that as a :+1: :)