Use Sphinx to Generate your JS Library DocsΒΆ

This is a how-to that guides developers through the process of creating documentation for their JS libraries, using Sphinx. While I originally favoured tools such as Markdown and the Github wiki, I found it difficult to keep things up to date. Using Sphinx and online services such as http://readthedocs.org/ made things feel much more managable.

The guide is designed to be use in conjuction with the Sphinx Documentation and references to that material are made when it makes sense. If this guide does not specifically mention how to do something, then be sure to search the Sphinx Documentation also.

Next topic

Getting Started

This Page