[CLOSED] Documentation for a rpy project with sphinx

Discuss how to use the Ren'Py engine to create visual novels and story-based games. New releases are announced in this section.
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.
Post Reply
Message
Author
User avatar
jghibiki
Regular
Posts: 125
Joined: Wed Sep 19, 2012 9:08 pm
Projects: Dream's Dénouement, Unannounced RPG framework, Renpy-Safe Logger
Organization: Team Anarky
IRC Nick: jghibiki
Location: Minnesota, US
Contact:

[CLOSED] Documentation for a rpy project with sphinx

#1 Post by jghibiki »

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.
_______________________________________
jghibiki
Web/Twitter/Tumblr

Post Reply

Who is online

Users browsing this forum: Ahrefs [Bot]