Sphinx

References

• Glossary
• First Steps
• Invocation

Invocation

• sphinx-build [options] sourcedir builddir [filenames]
  • -b {html (default), dirhtml (single dir per page), singlehtml, latex, man, more.. }
  • -j N - use N multithreads to build
  • -n - run in nitpicky mode
• sphinx-apidoc [options] -o outputdir packagedir [pathnames]
  • -o outputdir
  • -n, or --dry-run

Definitions

• Source directory - the directory which contains all source files for one sphinx project