Docs: fix warnings

Still 3 left: * guide/file_browser.rst: WARNING: document isn't included in any toctree * guide/fromNuke_01.rst: WARNING: document isn't included in any toctree * guide/thenodes-merge.rst: WARNING: document isn't included in any toctree
NatronGitHub · Sep 17, 2021 · 1f7ee32 · 1f7ee32
1 parent 00f58a9
commit 1f7ee32
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 20 deletions.
diff --git a/Documentation/source/guide/getstarted-about-mainconcepts.rst b/Documentation/source/guide/getstarted-about-mainconcepts.rst
@@ -13,7 +13,7 @@ The purpose of Natron is to process video images using elementary "effect" brick
 
 
 Image Layers and Channels
-#####
+#########################
 
 In natron an image is only a stack of black and white images called channels. channels are grouped in layers.
 The Color layer is the base layer. Color layer has channels R,G,B,A

diff --git a/Documentation/source/guide/getstarted-environment-fileselect.rst b/Documentation/source/guide/getstarted-environment-fileselect.rst
@@ -15,8 +15,8 @@ in order to allow moving files without breaking links or to allow sharing files
 The Short method 
 :::::::::::::::::
 To use path relative to the current Natron .ntp project file
--  Save your current project where you want but in the disk tree as your video files.
-  This creates a [project] entry in the Project Paths list
+
+- Save your current project where you want but in the disk tree as your video files. This creates a [project] entry in the Project Paths list
 - Create a read or write file. You have now access to Files path relative to the current .ntp file by selecting Relative to:[project]
 
 .. image:: _images/File_Browser-Project_Path.gif
@@ -78,10 +78,11 @@ image.####.jpg 1-3
 
 If you want to pick a single image of the list you should switch the 'sequence' button to 'File' to see each individual file.
 
-|When you set the filename in the bottom line you can tell Natron  how many digits it should use to write or read the files:
-|image.####.jpg
-|or 
-|image.%04d.jpg
+|  When you set the filename in the bottom line you can tell Natron  how many digits it should use to write or read the files:
+|  image.####.jpg
+|  or
+|  image.%04d.jpg
+
 These are two different ways to tell Natron to use 4 digits in the file name. This is called padding
 
 .. note::

diff --git a/Documentation/source/guide/getstarted-environment-nodegraph.rst b/Documentation/source/guide/getstarted-environment-nodegraph.rst
@@ -31,6 +31,7 @@ Rearrange Nodes
 ---------------
 - Select several nodes connected in chain
 - press shortcut ``L``
+
 Nodes are automatically aligned vertically without moving the last one
 
 .. image:: _images/Environment/environment-rearrange-node-graph.gif
@@ -51,7 +52,9 @@ Colored backdrops in a node graph.
 Create a backdrop
   - Tools Palette "Other"
   - Select "Backdrop
+
   or
+
   - Press ``Tab``
   - Type "bac"
   - Select Backdrop in the list

diff --git a/Documentation/source/guide/thenodes-draw-lightwrap.rst b/Documentation/source/guide/thenodes-draw-lightwrap.rst
@@ -2,7 +2,7 @@
     http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
 
 Lightwrap Node
-=========
+==============
 
 LightWrap helps composite objects onto a bright background by simulating reflections from the background light on the foreground, around its edges. 
 

diff --git a/Documentation/source/guide/thenodes-draw-plasma.rst b/Documentation/source/guide/thenodes-draw-plasma.rst
@@ -2,7 +2,7 @@
     http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
 
 Plasma Node
-=========
+===========
 
 Creates cloudy  noise. Brightness of the result can be modulated by the source image
 

diff --git a/Documentation/source/guide/thenodes-draw-radial.rst b/Documentation/source/guide/thenodes-draw-radial.rst
@@ -2,7 +2,7 @@
     http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
 
 Radial Node
-=========
+===========
 
 Radial creates a radial gradient. 
 

diff --git a/Documentation/source/guide/thenodes-draw-rand_noise.rst b/Documentation/source/guide/thenodes-draw-rand_noise.rst
@@ -8,6 +8,7 @@ Creates uniform Random noise.
 This node alone is not suitable for image regrain.
 
 .. image:: _images/TheNodes-Draw/nodes_draw_rand01.jpg
+
 2 different Rand with different values of "Density"
 
 
@@ -21,11 +22,12 @@ The "Density" parameter allows to change the average distance between the random
 check "Static Seed" for a freeze frame of the effect
 
 Noise Node
-=========
+==========
 
 Creates noiseover the source image.
 
 .. image:: _images/TheNodes-Draw/nodes_draw_noise01PoissonGaussian.jpg
+
 2 different types of Noise. Poisson on the left, Gaussian on the right.
 
 

diff --git a/Documentation/source/guide/thenodes-draw-rectangle.rst b/Documentation/source/guide/thenodes-draw-rectangle.rst
@@ -2,7 +2,7 @@
     http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
 
 Rectangle Node
-=========
+==============
 
 the Rectangle node makes rectangle shapes. It can add rounded corners and soft edges to the shapes.
 It is very useful for masking off a color adjustment and its softness parameter can be edited without compromising its edge values too much. Frequently use it to mask out nebulous regions of an effect. 

diff --git a/Documentation/source/guide/thenodes-image-read.rst b/Documentation/source/guide/thenodes-image-read.rst
@@ -104,8 +104,8 @@ The file will be converted from "File colorspace" to "Output Colorspace"
 
 .. note::
    **Tips:**
-  * It is recommended to leave "Output" to linear as this is the recommended basic workflow in Natron
-  * When file and Output spaces are the same, no conversion will occur
+     * It is recommended to leave "Output" to linear as this is the recommended basic workflow in Natron
+     * When file and Output spaces are the same, no conversion will occur
 
 See :doc:`The readers <compositing-projects-readers>` section for more information.
 
diff --git a/Documentation/source/guide/thenodes-image-write.rst b/Documentation/source/guide/thenodes-image-write.rst
@@ -50,11 +50,10 @@ The write node can change the color space of the output image.
 The file will be converted from "Input colorspace" to "File Colorspace"
 
 .. note::
-   **Tips:**
-   Natron
-  * It is recommended to leave "Input" to linear as this is the recommended basic workflow in Natron
-  * When file and Input spaces are the same, no conversion will occur
-  * Output usually is set to the same colorspace as the main read node. This results in an unmodified image.
+   **Tips:** Natron
+     * It is recommended to leave "Input" to linear as this is the recommended basic workflow in Natron
+     * When file and Input spaces are the same, no conversion will occur
+     * Output usually is set to the same colorspace as the main read node. This results in an unmodified image.
 
 Interpretation
 --------------
@@ -88,7 +87,8 @@ The read node can change the way an image is rendered from the values in the dis
 
 
 quicktime options:
-- Frame rate 
+
+* Frame rate
    defaults to the value in the project settings. It can be overriden for movie file types. Image sequence don't have Frame rate.