I'd like to use Sphinx to generate documentation for a project that I'm working on in Ren'py. I know that Ren'py also uses sphinx so i was curious if it would be possible to set sphinx up to create documentation for python functions written in .rpy files as well as functions written in .py files, using the docstrings.
Edit:
In the end I ended up creating my own solution after a suggestion from Pytom. The solution involved writing a script to extract the docstrings from my renpy structures and outputting them to files and a location the sphinx can pretty easily work with.
-->The script I wrote can be found here.<--
No guarantees that it will work with every project.
[CLOSED] Documentation for a rpy project with sphinx
Forum rules
This is the right place for Ren'Py help. Please ask one question per thread, use a descriptive subject like 'NotFound error in option.rpy' , and include all the relevant information - especially any relevant code and traceback messages. Use the code tag to format scripts.
This is the right place for Ren'Py help. Please ask one question per thread, use a descriptive subject like 'NotFound error in option.rpy' , and include all the relevant information - especially any relevant code and traceback messages. Use the code tag to format scripts.
Who is online
Users browsing this forum: Ahrefs [Bot]