wiki:Documentation/About

About the Sphinx documentation

The build system finds Sphinx documents to install in this way:

  • It looks for directories named "doc". Any doc/ directory may contain a sphinx document. ( This is just find . -name doc )
  • If a doc directory contains a file named no_auto_build, that doc directory is ignored
  • If a doc directory contains a file named Makefile, that makefile is used to build the sphinx document
  • If a doc does not contain a file named Makefile, that directory is ignored

If you have multiple documents, make multiple doc directories. e.g.

package/
package/doc/
package/doc/programmers/doc
    # programmers guide sphinx document
package/doc/users/doc
    # users guide sphinx document

In this scheme, package/doc is ignored because it doesn't have Makefile. It does not need to be named "doc", but it may be convenient to always have all the documentation under package/doc/.

Last modified 7 years ago Last modified on 06/13/12 14:07:40