Updating the VSE documentation #87729

Open
opened 2021-04-22 21:41:58 +02:00 by Hugo Schouppe · 7 comments

Updating the VSE documentation from a work-flow oriented standpoint.

A work in progress can be found here: https://vse-docs.readthedocs.io

Updating the VSE documentation from a work-flow oriented standpoint. A work in progress can be found here: https://vse-docs.readthedocs.io
Hugo Schouppe self-assigned this 2021-04-22 21:41:58 +02:00
Author

Added subscriber: @HUSCH

Added subscriber: @HUSCH
Member

Changed status from 'Needs Triage' to: 'Confirmed'

Changed status from 'Needs Triage' to: 'Confirmed'
Member

Added subscriber: @Blendify

Added subscriber: @Blendify
Author

In the Readthedocs VSE documentation, I refer to the original manual with external links (e.g. https://docs.blender.org/manual/ ...). I can use also internal links (e.g. :doc:...) but then I should know the exact path where the future VSE docs will reside. At the moment, there is a section video_editing (with 2 sub folders sequencer & preview). Perhaps the new VSE docs will reside there? Is it OK then to create internal links to the other manual sections; for example to the Tabs & panel section with :doc:Tabs & panels </interface/window_system/tabs_panels.rst> This will work in the local preview (auto_build) on my machine and eventually later on at the Blender site, but not in the ReadTheDocs site).

In the Readthedocs VSE documentation, I refer to the original manual with external links (e.g. https://docs.blender.org/manual/ ...). I can use also internal links (e.g. :doc:...) but then I should know the exact path where the future VSE docs will reside. At the moment, there is a section video_editing (with 2 sub folders sequencer & preview). Perhaps the new VSE docs will reside there? Is it OK then to create internal links to the other manual sections; for example to the Tabs & panel section with :doc:`Tabs & panels </interface/window_system/tabs_panels.rst>` This will work in the local preview (auto_build) on my machine and eventually later on at the Blender site, but not in the ReadTheDocs site).
Member

Whichever works best for your workflow, by the time things get merged everything should use internal links.

Whichever works best for your workflow, by the time things get merged everything should use internal links.
Author
  • Default line length set to 120 characters in VS Code. From now on, this should be OK.
  • The file strip-types.rst is renamed as index.rst. Should I do that also for the other 'top-level' files of a folder (e.g. the file organize.rst within the folder organize)?
  • The extension 'sphinx.ext.intersphinx' is added to the config.py. Should/can I use another syntax to refer to Blender docs? Now, I use something like Tabs & panels <https://docs.blender.org/manual/en/dev/interface/window_system/tabs_panels.html>_.
  • A make file is added. Now I use auto-build. Should I use that make-file to preview the output of the rst-files?
  • Not sure, but a _build/html folder is added (maybe it's a leftover from earlier). When I use the make-file, will it create this folder. Right now, I create my HTML files on a separate disk with auto-build. I would prefer it that way.
- Default line length set to 120 characters in VS Code. From now on, this should be OK. - The file strip-types.rst is renamed as index.rst. Should I do that also for the other 'top-level' files of a folder (e.g. the file organize.rst within the folder organize)? - The extension 'sphinx.ext.intersphinx' is added to the config.py. Should/can I use another syntax to refer to Blender docs? Now, I use something like `Tabs & panels <https://docs.blender.org/manual/en/dev/interface/window_system/tabs_panels.html>`_. - A make file is added. Now I use auto-build. Should I use that make-file to preview the output of the rst-files? - Not sure, but a _build/html folder is added (maybe it's a leftover from earlier). When I use the make-file, will it create this folder. Right now, I create my HTML files on a separate disk with auto-build. I would prefer it that way.
Member
  • Sounds good
  • Yes, this is needed to prevent 403 errors when you forget a page name in the URL; for example, https://docs.blender.org/manual/en/latest/video_editing/sequencer/toolbar/
  • You do not have to use this, it only works for some links, it was just an idea I had to try to help the transition but I don't think it is that helpful.
  • You don't have to use the make files, I added them because it helps me with my workflow because I am used to using them with the Blender Manual

You can ignore this folder, it won't affect what is visible online https://github.com/blendoc/vse-docs

- Sounds good - Yes, this is needed to prevent 403 errors when you forget a page name in the URL; for example, https://docs.blender.org/manual/en/latest/video_editing/sequencer/toolbar/ - You do not have to use this, it only works for some links, it was just an idea I had to try to help the transition but I don't think it is that helpful. - You don't have to use the make files, I added them because it helps me with my workflow because I am used to using them with the Blender Manual # You can ignore this folder, it won't affect what is visible online https://github.com/blendoc/vse-docs
Sign in to join this conversation.
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-manual#87729
No description provided.