Hi, everyone.
First off, Sphinx is awesome. I am using it to document all my Python
stuff (autodoc is especially helpful in that regard). But I was
wondering how it could be applied to non-programming pursuits.
Specifically, I was thinking about the possibility of writing role-
playing supplements for the GURPS system in Sphinx, probably with a
"gurps" domain. It seems like this would be a perfect job for Sphinx,
since skills and advantages in GURPS usually have structured data
associated, for example:
.. disadvantage:: Code OCD
:mental:
:selfcontrol:
:cost: 5
You are very stringent about following proper coding style. You
react at -2 to people who consistently write code not up to your
standards, and if you can see the source code of a program, you must
make a self-control roll to run it without bringing it up to style.
.. example::
Jared has Code OCD (9). Bob writes a script for Jared in Python
that exploits a flaw in the enemy's server, but uses javaStyleNames.
Jared makes a self-control roll, and rolls an 11, thus failing. He has
to spend a few minutes removing capitals and adding underscores before
he can run it.
Which brings me to the main point of my post. I tried looking at some
of the default domains to figure out how domains worked, but I'm
having trouble understanding it, since there's a lot going on in all
the domains. (The internal workings of docutils have always been
opaque to me.) I think that having a tutorial on how to create a
custom domain would be useful in that regard. (It might be interesting
to walk through both a programming domain and a nonprogramming one, to
expand Sphinx's use in that area.)
--
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.
