doc: update

ubisoft · Jan 5, 2022 · 78a2af8 · 78a2af8
1 parent 6d01cf5
commit 78a2af8
Show file tree

Hide file tree

Showing 8 changed files with 105 additions and 128 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -23,5 +23,13 @@
     "python.testing.promptToConfigure": false,
     "python.testing.pytestEnabled": false,
     "python.testing.nosetestsEnabled": false,
-    "restructuredtext.confPath": "${workspaceFolder}\\docs"
+    "restructuredtext.confPath": "${workspaceFolder}\\docs",
+    "spellright.language": [
+        "en"
+    ],
+    "spellright.documentTypes": [
+        "markdown",
+        "latex",
+        "plaintext"
+    ]
 }
diff --git a/README.md b/README.md
@@ -23,9 +23,10 @@ It is a flexible alternative to the Metadata post processing integrated system o
 
 
 ## Disclaimer
->**This tool is currently supported for LTS versions of Blender 2.83 and 2.93.**
+
+>**This tool is currently supported for LTS version of Blender 2.93 and up to Blender 3.0**
 >
->It was initialy developed for an animated TV series production in 2020 on Blender 2.83. It has the features that were needed at the time but it
+>It was initially developed for an animated TV series production in 2020 on Blender 2.83. It has the features that were needed at the time but it
 may not be considered as feature complete for a more generic purpose. In spite of all our efforts to make it reliable some troubles may occur in use cases we have not faced.
 >
 
@@ -39,17 +40,8 @@ Stamp Info can be installed as any standard Blender add-on. Nevertheless:
 >The addon must be installed in Administrator mode so that the Pillow Python library can
 >be downloaded and deployed correctly. Also be sure that your firewall doesn't block the download (or use OpenVPN or equivalent).
 
-Launch Blender, open the Preferences panel and go to the Add-ons section. Press the Install button located at the top of the panel. A dialog box opens, pick the Stamp Info zip file you previously downloaded and validate. The add-on will be installed. Click on the checkbox at the left side of its name to enable it.
-Once the addon is enabled, a Stamp Info tab is displayed in the 3D viewport N-Panel.
-
-Now close Blender to save your user preferences with the Stamp Info installation.
-
-
-## Features
+Refer to the documentation for the detailed installation steps: [https://ubisoft-stampinfo.readthedocs.io/en/latest/getting-started/install.html](https://ubisoft-stampinfo.readthedocs.io/en/latest/getting-started/install.html)
 
-- [Features](./doc/features.md)
-- [Limitations](./doc/features.md#limitations)
-- [History](./CHANGELOG.md)
 
 ## Principle
 
@@ -68,6 +60,11 @@ Now close Blender to save your user preferences with the Stamp Info installation
    Note: In order to mimic as much as possible the actual way of working of Blender and so as to avoid frames in a rendered sequences to be
    overwritten by mistake the still images are saved on disk with a file name starting with the prefix "_Still".
 
+## Features
+
+- [Features and limitations](https://ubisoft-stampinfo.readthedocs.io/en/latest/features/features.html)
+- [History](./CHANGELOG.md)
+
 
 # FAQ and Troubleshooting
 

diff --git a/doc/features.md b/doc/features.md
diff --git a/docs/features/features.rst b/docs/features/features.rst
@@ -5,9 +5,24 @@
 
 .. _features:
 
+Features and limitations
+========================
+
+
+
+
+Information categories
+----------------------
+
+* :ref:`Time and frames information <time-and-frame-info>`
+* :ref:`Shot and camera information <shot-and-camera-info>`
+* :ref:`Metadata information <metadata-info>`
+
+
+
 
 Setting up the final resolution
-===============================
+-------------------------------
 
 The Final Resolution Mode defines how the metadata will be arranged over the rendered image.
 
@@ -38,59 +53,7 @@ it saves rendering time while preserving the same aspect ratio for the cameras i
 For a more detailed description of these values watch `this part of the video tutorial <https://youtu.be/Sj2GyYhxFX4?t=272>`__.
 
 
-Information categories
-======================
-
-Time and frames
-----------------
-
-Information related to the frame index, animation range and framerate...
-
-Animation range
-+++++++++++++++
-
-    ..  image:: /img/features/SI_Range__0001_Conventions-02.jpg
-        :align: center
-
-    ..  image:: /img/features/SI_Range__0004_Consequences-on-range-03.jpg
-        :align: center
-
-    ..  image:: /img/features/SI_Range__0005_Consequences-on-duration.jpg
-        :align: center
-
-
-|br|
-
-Handles
-+++++++
-
-    ..  image:: /img/features/SI_Hand__0002_Handles-03.jpg
-        :align: center
-
-    ..  image:: /img/features/SI_Hand__0005_Handles-Tips-03.jpg
-        :align: center
-
-    ..  image:: /img/features/SI_Hand__0007_Handles-Tips-05.jpg
-        :align: center
-
-
-
-|br|
-
-Shot and camera
----------------
-
-Scene, sequence, take and shot names, as well as camera name and lens value.
-
-
-Metadata
---------
-
-Project name and logo, user name, rendering date and time, custom notes.
-
 
-Layout categories
-=================
 
 Text and layout
 ---------------

diff --git a/docs/features/metadata-info.rst b/docs/features/metadata-info.rst
@@ -0,0 +1,13 @@
+.. |br| raw:: html
+
+  <br/>
+
+
+.. _metadata-info:
+
+Metadata information
+====================
+
+Project name and logo, user name, rendering date and time, custom notes.
+
+
diff --git a/docs/features/shot-and-camera-info.rst b/docs/features/shot-and-camera-info.rst
@@ -0,0 +1,10 @@
+.. |br| raw:: html
+
+  <br/>
+
+
+.. _shot-and-camera-info:
+
+Shot and camera information
+===========================
+
diff --git a/docs/features/time-and-frame-info.rst b/docs/features/time-and-frame-info.rst
@@ -0,0 +1,42 @@
+.. |br| raw:: html
+
+  <br/>
+
+
+.. _time-and-frame-info:
+
+
+Time and frame information
+--------------------------
+
+Information related to the frame index, animation range and framerate...
+
+Animation range
++++++++++++++++
+
+    ..  image:: /img/features/SI_Range__0001_Conventions-02.jpg
+        :align: center
+
+    ..  image:: /img/features/SI_Range__0004_Consequences-on-range-03.jpg
+        :align: center
+
+    ..  image:: /img/features/SI_Range__0005_Consequences-on-duration.jpg
+        :align: center
+
+
+|br|
+
+Handles
++++++++
+
+    ..  image:: /img/features/SI_Hand__0002_Handles-03.jpg
+        :align: center
+
+    ..  image:: /img/features/SI_Hand__0005_Handles-Tips-03.jpg
+        :align: center
+
+    ..  image:: /img/features/SI_Hand__0007_Handles-Tips-05.jpg
+        :align: center
+
+
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
 .. |br| raw:: html
-   
+
   <br/>
 
 ..  image:: /img/ubisoft_logo.png
@@ -10,12 +10,13 @@ Ubisoft Stamp Info: Write text on images rendered with Blender
 
 **Print all the scene and animation information required to understand the context of an image directly onto the rendered outputs.**
 
+**Current version is 1.0. The currently supported Blender versions are 2.93.x and 3.0.x.**
+
 ..  image:: /img/StampInfo_Screen.jpg
     :align: center
     :width: 80%
 
 
-|br|
 See how this tool was used in production: `User Stories - Blender and the Rabbids <https://www.blender.org/user-stories/blender-and-the-rabbids/?utm_source=www-homepage>`__.
 
 
@@ -67,6 +68,9 @@ Then:
    :caption: Features
 
    /features/features
+   /features/time-and-frame-info
+   /features/shot-and-camera-info
+   /features/metadata-info
 
 
 .. toctree::