diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 97e027a33..7e1f41522 100644 --- a/docs/sphinx/conf.py +++ b/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' diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index fd1008d73..a67aade73 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -8,19 +8,36 @@ Welcome to OBS Studio's documentation! ====================================== +* **Setting up an OBS development environment?** :wiki:`Use the Wiki ` +* **Developing your first OBS plugin?** `Use the obs-plugintemplate `_ + .. 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 + Modules + Core API Object + Platform/Utility + Callbacks (libobs/callback) + Graphics (libobs/graphics) + Media I/O (libobs/media-io) reference-frontend-api + +.. toctree:: + :caption: Additional Resources + :maxdepth: 1 + :hidden: + + Build Instructions + Plugin Template \ No newline at end of file diff --git a/docs/sphinx/logo.svg b/docs/sphinx/logo.svg new file mode 100644 index 000000000..b37fc4b16 --- /dev/null +++ b/docs/sphinx/logo.svg @@ -0,0 +1,268 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/sphinx/plugins.rst b/docs/sphinx/plugins.rst index ba0515486..bb474ba0e 100644 --- a/docs/sphinx/plugins.rst +++ b/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 `_ +to get you started. Plugin Module Headers --------------------- diff --git a/docs/sphinx/reference-core-objects.rst b/docs/sphinx/reference-core-objects.rst index 8949b586c..a79de534a 100644 --- a/docs/sphinx/reference-core-objects.rst +++ b/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) + Scenes (obs_scene_t) + Outputs (obs_output_t) + Encoders (obs_encoder_t) + Services (obs_service_t) + Data Settings (obs_data_t) + Properties (obs_properties_t)