docstrings not showing up on website

MTgeophysics / mtpy

Python toolbox for standard Magnetotelluric (MT) data analysis

GNU General Public License v3.0

145 stars 66 forks source link

docstrings not showing up on website #80

Closed lheagy closed 5 years ago

lheagy commented 5 years ago

(related to the JOSS review openjournals/joss-reviews#1358)

Currently, the docstrings describing the modules are not displaying online. For example: https://mtpy2.readthedocs.io/en/develop/core.html

Also, I saw that you have a user-guide in the docs directory, but this isn't easily findable from the docs website. It might be worth including a link on the main documentation page.

alkirkby commented 5 years ago

This has now been fixed - documentation is compiling correctly now and a link to the user guide has been added to the front page.