morpho executable docstrings do not appear on readthedocs

[joejohnston203]

Doc strings have been added to the morpho executable, but readthedocs is only showing docstrings from code inside the morpho folder.

http://morpho.readthedocs.io/en/latest/

[laroque]

in the conf.py file line 50 (https://github.com/project8/morpho/blob/d7600e3965f852ed2eae6fbf64e88c0102c3462c/documentation/conf.py#L50) you have to list the directories which should be scanned for files to document.

As an organizational question, wouldn't it make more sense for methods needing docstrings to be in the library rather than the executable (the executable isn't part of the library which means a user isn't going to import it and actually call those functions).

You do, however, want to document the shell usage and possibly other aspects of the executable. Sphinx has an extension that will grab program output (which could be used with morpho --help to get the usage out of argparse). There may be other sphinx extensions for executables which do more what you're looking for but you'd need to look through the sphinx documentation to decide what works best in this case.

[joejohnston203]

I see, thank you. None of the methods in the morpho executable should be needed by a user, so probably the current setup is what we want.

Adding help output, and possible other output does sounds useful. I will look into adding those to our documentation.