index.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. .. OBS Studio documentation master file, created by
  2. sphinx-quickstart on Wed Oct 25 00:03:21 2017.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. .. _contents:
  6. Welcome to OBS Studio's documentation!
  7. ======================================
  8. * **Setting up an OBS development environment?** :wiki:`Use the Wiki <Install-Instructions>`
  9. * **Developing your first OBS plugin?** `Use the obs-plugintemplate <https://github.com/obsproject/obs-plugintemplate#obs-plugin-template>`_
  10. .. toctree::
  11. :caption: Core Concepts
  12. :maxdepth: 1
  13. backend-design
  14. plugins
  15. frontends
  16. graphics
  17. scripting
  18. .. toctree::
  19. :caption: API Reference
  20. :maxdepth: 2
  21. OBS Core <reference-core>
  22. Modules <reference-modules>
  23. Core API Object <reference-core-objects>
  24. Platform/Utility <reference-libobs-util>
  25. Callbacks (libobs/callback) <reference-libobs-callback>
  26. Graphics (libobs/graphics) <reference-libobs-graphics>
  27. Media I/O (libobs/media-io) <reference-libobs-media-io>
  28. reference-frontend-api
  29. .. toctree::
  30. :caption: Additional Resources
  31. :maxdepth: 1
  32. :hidden:
  33. Build Instructions <https://obsproject.com/wiki/Install-Instructions>
  34. Plugin Template <https://github.com/obsproject/obs-plugintemplate#obs-plugin-template>