Docs keying

[blackearth2014]

Created 3 documents that include using the Hue Keyer, Multipass Keying, and Greenscreen dispilling tips.

[coveralls]

Coverage remained the same at 0.0% when pulling e130c38 on blackearth2014:docs_keying into f9f0f50 on NatronGitHub:RB-2.4.

[devernay]

Cannot review at the moment.
compiled version available at https://natron--617.org.readthedocs.build/en/617/

[blackearth2014]

Cannot review at the moment.
compiled version available at https://natron--617.org.readthedocs.build/en/617/

Thanks but there is no mac version. I will check next week.

[devernay]

by "compiled" I meant that the doc is available online at this address, but it seems like:

• your additions do not have the right file extension (rst)
• they are not referenced in the table of contents. Where would you put these?

[blackearth2014]

Fred, I think had forgotten to put the word tutorial first in the title. Also, I had just notice that GitHub b doesn't automatically save the extension to the doc file. The docs are in the Natron-1/documentation/software//guide under docs_keying directory. The images are in the _images folder. How do I rename docs after I had saved them?

…

On Fri, May 21, 2021, 5:27 PM Frédéric Devernay ***@***.***> wrote: by "compiled" I meant that the doc is available online at this address, but it seems like: - your additions do not have the right file extension (rst) - they are not referenced in the table of contents. Where would you put these? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#617 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB4WTJJYAWNGE7TMFVKZ42LTO3F25ANCNFSM44D3B64Q> .

[blackearth2014]

Fred, I had just renamed the files with word tutorial in the name and out the .rst as the extension.

…

On Fri, May 21, 2021, 5:37 PM Media Chambers ***@***.***> wrote: Fred, I think had forgotten to put the word tutorial first in the title. Also, I had just notice that GitHub b doesn't automatically save the extension to the doc file. The docs are in the Natron-1/documentation/software//guide under docs_keying directory. The images are in the _images folder. How do I rename docs after I had saved them? On Fri, May 21, 2021, 5:27 PM Frédéric Devernay ***@***.***> wrote: > by "compiled" I meant that the doc is available online at this address, > but it seems like: > > - your additions do not have the right file extension (rst) > - they are not referenced in the table of contents. Where would you > put these? > > — > You are receiving this because you authored the thread. > Reply to this email directly, view it on GitHub > <#617 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AB4WTJJYAWNGE7TMFVKZ42LTO3F25ANCNFSM44D3B64Q> > . >

[blackearth2014]

And I did another pulled request

…

On Fri, May 21, 2021, 5:45 PM Media Chambers ***@***.***> wrote: Fred, I had just renamed the files with word tutorial in the name and out the .rst as the extension. On Fri, May 21, 2021, 5:37 PM Media Chambers ***@***.***> wrote: > Fred, > > I think had forgotten to put the word tutorial first in the title. Also, > I had just notice that GitHub b doesn't automatically save the extension to > the doc file. > > The docs are in the Natron-1/documentation/software//guide under > docs_keying directory. The images are in the _images folder. How do I > rename docs after I had saved them? > > On Fri, May 21, 2021, 5:27 PM Frédéric Devernay ***@***.***> > wrote: > >> by "compiled" I meant that the doc is available online at this address, >> but it seems like: >> >> - your additions do not have the right file extension (rst) >> - they are not referenced in the table of contents. Where would you >> put these? >> >> — >> You are receiving this because you authored the thread. >> Reply to this email directly, view it on GitHub >> <#617 (comment)>, >> or unsubscribe >> <https://github.com/notifications/unsubscribe-auth/AB4WTJJYAWNGE7TMFVKZ42LTO3F25ANCNFSM44D3B64Q> >> . >> >

[bonalex01dev]

Hello, @blackearth2014, I didn't succeed to review your work either.
I suggest we integrate our additions to the docs the best we can with the existing pages.
I suggest:

• create "tutorials-keying.rst" with a link to your pages inside.

  :maxdepth: 2
  tutorials/tutorial-multikeyer ```
  

• edit the existing "tutorials.rst" adding a link to "tutorials-keying" in the toctree
• edit the existing "compositing-keying.rst" with a link to your pages something like
  See :doc:`The multi keyer tutorial <tutorial-multikeyer>` section for more informations.

My understanding is that:
your pages may not be compiled if they are not integrated in the tree starting from "index.rst".
The docs says:
Sphinx requires that the toctree lists include all pages. If a page is not in any toctree list, it is a page with no parent page, or an “orphan” page, and the Sphinx build will produce an error. If for some reason a page must be in the documentation and must not be in the left navigation, the :orphan: directive can be added at the top of that page so that Sphinx will build without errors. Please avoid the :orphan: directive as much as possible. ( some of my submits may suffer the same problem I'll have to be carefull)

[bonalex01dev]

@devernay @blackearth2014 @olear
I think it's time to get more organised for the docs. What about sharing a kanban workboard or something similar (Blender docs have one).