Pygame documentation generated with Sphinx
13 views
Skip to first unread message
Lenard Lindstrom
Nov 11, 2016, 7:41:10 PM11/11/16
to sphinx-users
Hi everyone,
As a Pygame developer I wish to mention that Sphinx has been used to generate our html documentation from reStructuredText source for some years now. Prior to that a custom markup and tool chain was used. The switch was made to encourage document upkeep, by using a known tool, and to add flexibility in the build process, the possibility of multiple themes and document formats.
The document source is written using standard docutils and Sphinx directives. The docs are built using a custom theme and Sphinx extension to match their original appearance. These customizations can be found in the Pygame source at the Pygame repository hosted on Bitbucket, under the docs/reST subdirectory.
We Pygame developers would be glad to see Pygame added to the Projects using Sphinx page.
Lenard Lindstrom
As a Pygame developer I wish to mention that Sphinx has been used to generate our html documentation from reStructuredText source for some years now. Prior to that a custom markup and tool chain was used. The switch was made to encourage document upkeep, by using a known tool, and to add flexibility in the build process, the possibility of multiple themes and document formats.
The document source is written using standard docutils and Sphinx directives. The docs are built using a custom theme and Sphinx extension to match their original appearance. These customizations can be found in the Pygame source at the Pygame repository hosted on Bitbucket, under the docs/reST subdirectory.
We Pygame developers would be glad to see Pygame added to the Projects using Sphinx page.
Lenard Lindstrom
Takayuki Shimizukawa
Nov 12, 2016, 12:20:57 AM11/12/16
to sphinx-users
--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
Reply all
Reply to author
Forward
0 new messages