Hi All,
I have just found Sphinx after several days of search to find a tool
that can be used to document JavaScript APIs.
The JavaScript APIs I need to document are not part of a traditional
web browser, and the APIs themselves are implemented in C++ and other
languages. They provide (sort of) the same thing what the DOM is in a
Web browser.
Many of the things in that API (to be used in JavaScript) take
arguments that are "JSON stuff". And properties inside those have the
same kind of description/purpose/type etc. documentation requirements
as function arguments. Something along the lines of:
new Something.Button( { color: "red", style: "sunken", ...});
or
someStuff.items = [ { text: "one", id: 1, image: "01.png"},
{ text: ...}, ... ];
What "members" can be in those JSON things, and what type they can be,
is restricted. Some of them are mandatory, some of them are optional
(with a default) etc. Of course, I would like to have that in the
documentation - just as if they were function parameters.
Looking at the Sphinx documentation I have not seen this capability.
Obviously, if I want it, I need to add it. Since I haven't work in
Python much, and not at all with Sphinx, I was wondering about a few
thing. I hope maybe you could help me out answering those questions?
- How difficult would it be to add this capability to Sphinx?
- Do I need to add it, or is there already an "idiom" of how to
document such things? (like document the JSON as a "pseudo type" or
something?)
- If I wanted to add this capability, where should I begin looking at
the code? Which files do I need to understand before I touch
anything?
Attila aka WW
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
