docs/sphinx: RTD-friendly documentation changes

docs/sphinx/conf.py

@@ -95,7 +95,7 @@ todo_include_todos = False
 #
 html_theme = 'sphinx_rtd_theme'
 html_theme_options = {
-    "logo_only": False,
+    "logo_only": True,
     "navigation_depth": 5,
     'prev_next_buttons_location': 'both',
     'vcs_pageview_mode': 'edit',
@@ -104,7 +104,7 @@ html_theme_options = {
     'collapse_navigation': False
 }
 
-html_logo = '../../icons/macos.png'
+html_logo = 'logo.svg'
 
 html_favicon = 'favicon.ico'
 

docs/sphinx/index.rst

@@ -8,19 +8,36 @@
 Welcome to OBS Studio's documentation!
 ======================================
 
+* **Setting up an OBS development environment?** :wiki:`Use the Wiki <Install-Instructions>`
+* **Developing your first OBS plugin?** `Use the obs-plugintemplate <https://github.com/obsproject/obs-plugintemplate#obs-plugin-template>`_
+
 .. toctree::
-   :maxdepth: 3
+   :caption: Core Concepts
+   :maxdepth: 1
 
    backend-design
    plugins
    frontends
    graphics
    scripting
-   reference-core
-   reference-modules
-   reference-core-objects
-   reference-libobs-util
-   reference-libobs-callback
-   reference-libobs-graphics
-   reference-libobs-media-io
+
+.. toctree::
+   :caption: API Reference
+   :maxdepth: 2
+
+   OBS Core <reference-core>
+   Modules <reference-modules>
+   Core API Object <reference-core-objects>
+   Platform/Utility <reference-libobs-util>
+   Callbacks (libobs/callback) <reference-libobs-callback>
+   Graphics (libobs/graphics) <reference-libobs-graphics>
+   Media I/O (libobs/media-io) <reference-libobs-media-io>
    reference-frontend-api
+
+.. toctree::
+   :caption: Additional Resources
+   :maxdepth: 1
+   :hidden:
+
+   Build Instructions <https://obsproject.com/wiki/Install-Instructions>
+   Plugin Template <https://github.com/obsproject/obs-plugintemplate#obs-plugin-template>

docs/sphinx/plugins.rst

@@ -8,6 +8,8 @@ plugin modules.
 
 Plugins can implement sources, outputs, encoders, and services.
 
+Writing your first plugin? We provide `a basic template plugin <https://github.com/obsproject/obs-plugintemplate#obs-plugin-template>`_
+to get you started.
 
 Plugin Module Headers
 ---------------------

docs/sphinx/reference-core-objects.rst

@@ -4,10 +4,10 @@ Core API Object Reference
 .. toctree::
    :maxdepth: 3
 
-   reference-sources
-   reference-scenes
-   reference-outputs
-   reference-encoders
-   reference-services
-   reference-settings
-   reference-properties
+   Sources (obs_source_t) <reference-sources>
+   Scenes (obs_scene_t) <reference-scenes>
+   Outputs (obs_output_t) <reference-outputs>
+   Encoders (obs_encoder_t) <reference-encoders>
+   Services (obs_service_t) <reference-services>
+   Data Settings (obs_data_t) <reference-settings>
+   Properties (obs_properties_t) <reference-properties>