0
votes

The advantages of this approach include:

  • Consistent docstring syntax everywhere
  • Centralsied documentation server; find all your docs in one place
  • Search and jump-to-source from any documented function or class; in either language

Are there any modules integrating with Sphinx or similar; which generate+put your JavaScript and Python documentation in one place?

1
I've been using sphinx-jsapidoc (since before I asked this question); and wasn't too impressed. I got it working, but it doesn't handle semantics (such as directives and modules); and additionally the jump-to-implementation feature seems broken. - A T

1 Answers

0
votes

I am not sure if your question is about public documentation or in-house documentation of some of your projects.

For the former you want to see this: http://devdocs.io/

Also devdocs document scrapers are open source, so you should be able to use them for your own projects to build custom devdocs.io.