From 440c9c4569987e47318babf78068433072f3e2f8 Mon Sep 17 00:00:00 2001 From: baldurk Date: Mon, 16 May 2016 14:43:46 +0200 Subject: [PATCH] Move in application API to root level --- docs/getting_started/index.rst | 1 - docs/getting_started/tips_tricks.rst | 4 ++-- docs/{getting_started => }/in_application_api.rst | 0 docs/index.rst | 1 + 4 files changed, 3 insertions(+), 3 deletions(-) rename docs/{getting_started => }/in_application_api.rst (100%) diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index b3275f7d1..64fd35eaf 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -9,4 +9,3 @@ Getting started quick_start features tips_tricks - in_application_api diff --git a/docs/getting_started/tips_tricks.rst b/docs/getting_started/tips_tricks.rst index 7108e43f5..d29cbaa16 100644 --- a/docs/getting_started/tips_tricks.rst +++ b/docs/getting_started/tips_tricks.rst @@ -22,7 +22,7 @@ This page is a random hodge-podge of different tips and tricks that might not be #. Similarly, right-clicking on the 'auto-fit' button |wand| will auto-fit whenever the texture or event changes, so that the visible range is maintained as you move through the frame. This can be useful if jumping between places where the visible range is very different. #. You can double click on a thumbnail in the texture viewer to open a :doc:`locked texture <../how/how_view_texture>` tab #. You can close tabs by middle clicking on them. -#. You can trigger a capture from code. renderdoc.dll exports an :doc:`in_application_api` for this purpose, defined in ``renderdoc_app.h`` in the distributions: +#. You can trigger a capture from code. renderdoc.dll exports an :doc:`../in_application_api` for this purpose, defined in ``renderdoc_app.h`` in the distributions: .. highlight:: c++ .. code:: c++ @@ -48,7 +48,7 @@ This page is a random hodge-podge of different tips and tricks that might not be #. When you have right clicked to select a pixel in the texture viewer, you can perform precise refinements with the arrow keys to nudge the selection in each direction. #. To get API debug or error messages, enable "Create Debug Device" when capturing then check out the :doc:`../window/debug_messages` window. -#. Detecting RenderDoc from your code can either be done by trying to load and use the renderdoc :doc:`in_application_api`, or through API specific ways: +#. Detecting RenderDoc from your code can either be done by trying to load and use the renderdoc :doc:`../in_application_api`, or through API specific ways: .. highlight:: c++ .. code:: c++ diff --git a/docs/getting_started/in_application_api.rst b/docs/in_application_api.rst similarity index 100% rename from docs/getting_started/in_application_api.rst rename to docs/in_application_api.rst diff --git a/docs/index.rst b/docs/index.rst index 7803220c2..b4ea407c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,7 @@ Table of Contents :maxdepth: 2 introduction + in_application_api credits_acknowledgements getting_started/index behind_scenes/index