-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Am 26.02.2010 17:35, schrieb Tomaz: > I'm a contributor to a small but incrementally growing OSS project and > the recent problem, that's been bugging me and some our end users, was > lack of proper documentation. > > Right now, all what we have is some generic API docs generated with > epydocs from epytext formatted docstring's. I'm thinking about > refactoring the docstring's to reST format, so we can adopt sphinx as > our primary docs generator. > > So my question is: Is there a decent format converter from epytext to > reST markup?
Not that I know of. > If not: I was working on a script that would try to naively convert > epytext to reST and then warn me is the reST markup is valid or not. I > bet you guys have developed some kind of reST validator - can someone > please point out the code of your validation mechanism ? Well, valid reST is everything that passes a docutils/sphinx run without warnings. Since reST is a very-near-plain text markup, it is sometimes hard to automatically detect markup errors, such as (for example) duplicated backticks. This is one disadvantage that (like dynamic typing in Python) is a necessary one to get at some of the advantages. Georg -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.14 (GNU/Linux) iEYEARECAAYFAkuJmhwACgkQN9GcIYhpnLAMbQCgrmd1Ml+RKa7jh/c+/JNqy/4c S/0An0uxsp4za0FMAF40jSpC4CMJt54T =embY -----END PGP SIGNATURE----- -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.