From what I've been able to tell from the interwebs, extracting
documentation (autodoc-fashion) from JS/C++/IDL isn't possible with
Sphinx. Is that correct?
This makes me sad because it means I probably have to end up
copy-pasting my source code documentation elsewhere either way (in which
case I might as well copy/paste into MDN myself). :-(
~ Gijs
On 12/12/13, 09:08 , Gregory Szorc wrote:
After I announced the in-tree build docs powered by Sphinx a few
months ago [1], a few people came to me and said "that's really cool -
I want something like that for my module."
I'm pleased to announce that as of bug 939367 landing in inbound a few
hours ago, you can now deposit Sphinx docs anywhere in the tree and
they will get picked up during `mach build-docs`. This feature is
self-documenting and you can find the instructions in the output of
`mach build-docs` or at [2]. See build/docs or services/docs in the
tree for what this looks like in practice.
Yes, the docs use the old MDN theme. They will use the new theme once
someone updates [3]. For all I know, someone is already hard at work
doing that. We also have bug 920314 tracking getting these docs
published on MDN.
Sphinx is extremely extensible. If you have ideas for better
integrating it with anything, let me know!
Please report any issues or questions you may have. Core :: Build
Config for now.
[1]
https://groups.google.com/d/msg/mozilla.dev.platform/HQOL8YKiJmE/wlvktOlQSpIJ
[2]
https://ci.mozilla.org/job/mozilla-central-docs/Tree_Documentation/index.html
[3] https://github.com/lmorchard/mozilla-mdn-sphinx-theme
_______________________________________________
firefox-dev mailing list
firefox-...@mozilla.org
https://mail.mozilla.org/listinfo/firefox-dev
_______________________________________________
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform
