Moved docs to readthedocs

mdolab / pysurf

pySurf provides geometric operations for triangulated surfaces.

Apache License 2.0

2 stars 4 forks source link

Moved docs to readthedocs #2

Closed sseraj closed 4 years ago

sseraj commented 4 years ago

Purpose

I converted the text files into rst and setup sphinx for the readthedocs build.

Type of change

Documentation update

ewu63 commented 4 years ago

Can you add an autodoc page on the API?

sseraj commented 4 years ago

Will autodoc work with py2? It wasn't working locally because I was using py3.

ewu63 commented 4 years ago

Hmm, you can tell RTD to build this with py2, but maybe we should update the code to run on py3 first for consistency. Can you open an issue for converting to py3 and mention that we should also enable autodoc at the same time?