[Bf-docboard-svn] bf-manual: [7392] trunk/blender_docs/manual/about/contribute/guides/markup_guide.rst: Document markup for RNA manual access
Aaron Carlisle
noreply at blender.org
Wed Nov 18 22:59:13 CET 2020
Revision: 7392
https://developer.blender.org/rBM7392
Author: Blendify
Date: 2020-11-18 22:59:12 +0100 (Wed, 18 Nov 2020)
Log Message:
-----------
Document markup for RNA manual access
Modified Paths:
--------------
trunk/blender_docs/manual/about/contribute/guides/markup_guide.rst
Modified: trunk/blender_docs/manual/about/contribute/guides/markup_guide.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/guides/markup_guide.rst 2020-11-18 21:43:34 UTC (rev 7391)
+++ trunk/blender_docs/manual/about/contribute/guides/markup_guide.rst 2020-11-18 21:59:12 UTC (rev 7392)
@@ -140,6 +140,36 @@
:Menu Item: Menu Item Definition
+Context Sensitive Manual Access
+===============================
+
+It is possible to link to a specific part of the manual from in Blender
+by right clicking on a property or operator and selecting *Online Manual*.
+In order for this to work, this needs to be accounted for in the documentation.
+To link a property or operator to a specific part of the manual you need
+to add an external reference link tag whose ID matches Blender's RNA tag.
+The easiest way to find out what the tag for a property is to right click on the
+property/operator and select *Online Python Reference* the extract the tag from the URL.
+Some examples of how this looks in the RST document are given below::
+
+ .. _bpy.types.FluidDomainSettings.use_fractions:
+
+ Fractional Obstacles
+ Enables finer resolution in fluid / obstacle regions (second order obstacles)...
+
+ .. _bpy.types.FluidDomainSettings.fractions_distance:
+
+ Obstacle Distance
+ Determines how far apart fluid and obstacles are....
+
+For an operator::
+
+ .. _bpy.ops.curve.subdivide:
+
+ Subdivide
+ =========
+
+
Code Samples
============
More information about the Bf-docboard-svn
mailing list