Forum Archive

I have been told that you should not generate documentation from code, and there are probably several good reasons behind that guideline. However, for the specific purpose of documenting and testing the small-scale projects I have using Pythonista, I really prefer maintaining only the docstrings that are in the code, and then generating the markdown documentation for Github.

docgen is a single-file utility that is intended to be run from the Pythonista action menu. Check the README file for usage.

For "real-life" examples of the generated documentation, see the Scripter and Gestures docs.

hello. I get an error: line 111
heading = f'Class: {c.name}'

@jmv38, my bad, I forgot to mention that this is Python 3.6 code, only available in Pythonista beta at the moment.

@jmv38, latest version no longer has the f-strings, so should be compatible with Python 3.5 and the App Store version of Pythonista.

thank you. It works fine now.