DaVinci Resolve Scripting API Documentation - Custom Style

Ask software engineering and SDK questions for developers working on Mac OS X, Windows or Linux.
  • Author
  • Message
Offline
User avatar

X-Raym

  • Posts: 152
  • Joined: Thu Apr 18, 2013 4:05 pm
  • Location: France
  • Real Name: Raymond Radet

DaVinci Resolve Scripting API Documentation - Custom Style

PostThu Oct 24, 2024 11:18 am

Hi !

I just release a formatted version of then DaVinci Resolve Scripting API Documentation README.txt,

Here is how it looks !

Image


I also wrote an article for the release.

Please let me know if it is helpful,
and if someone at BM want to discuss about formatting errors in the original file, just contact me!

Cheers ! ;)
My DaVinci Resolve Scripts: https://github.com/X-Raym/DaVinci-Resolve-Scripts
My Resolve Scripting API Doc: https://www.extremraym.com/en/resolve-api-doc-release/
Donation: https://paypal.me/extremraym
Offline

ba1anse

  • Posts: 1
  • Joined: Tue Nov 12, 2024 11:21 am
  • Real Name: shawn su

Re: DaVinci Resolve Scripting API Documentation - Custom Sty

PostTue Nov 12, 2024 11:31 am

Hi there,

Love the formatted version! Thanks for sharing.

However, the color scheme you've chosen makes readability not so great, specifically:
1. The font color of code (lime) is a bit too light
2. The font color of table text (gray?) is so similar to the table background color I find reading the text very difficult.

It'd be greatly appreciated if you could update the color scheme to enhance the readability, many thanks! :)
Offline
User avatar

X-Raym

  • Posts: 152
  • Joined: Thu Apr 18, 2013 4:05 pm
  • Location: France
  • Real Name: Raymond Radet

Re: DaVinci Resolve Scripting API Documentation - Custom Sty

PostTue Nov 12, 2024 11:34 pm

@ba1anse
653 views, first feedback ! Thanks ! (oh and its your first post ? nice :P)

I updated color scheme. More saturated code color and a bit darker table scheme (though I was fine with it), and darker code background.

If you want to go further, as it is coded in strict HTML, you can write your own styles if you want, using a browser extension like Stylus https://addons.mozilla.org/fr/firefox/addon/styl-us/ :P (need to know a bit about CSS though)

If you still find there are readability issue, please post a screenshot, just to be sure we see the same thing.
My DaVinci Resolve Scripts: https://github.com/X-Raym/DaVinci-Resolve-Scripts
My Resolve Scripting API Doc: https://www.extremraym.com/en/resolve-api-doc-release/
Donation: https://paypal.me/extremraym
Offline

CharCharSaur

  • Posts: 1
  • Joined: Mon Nov 25, 2024 12:23 am
  • Real Name: Charlotte Wilson-Lee

Re: DaVinci Resolve Scripting API Documentation - Custom Sty

PostMon Dec 02, 2024 6:24 am

I'm probably 90% of the views. The doc is great and the best formatting that I've found. Thank you very much!!
Offline
User avatar

X-Raym

  • Posts: 152
  • Joined: Thu Apr 18, 2013 4:05 pm
  • Location: France
  • Real Name: Raymond Radet

Re: DaVinci Resolve Scripting API Documentation - Custom Sty

PostTue Dec 03, 2024 10:06 am

@CharCharSaur
haha thanks for taking time to make feedback about this,
It seems to be the most visited page on my website this month, and users come from all over the world. ;)

I considered making same thing for UImanager documentation (Resolve GUI system for scripts) but it got removes from DR free in v19.1. :shock:
My DaVinci Resolve Scripts: https://github.com/X-Raym/DaVinci-Resolve-Scripts
My Resolve Scripting API Doc: https://www.extremraym.com/en/resolve-api-doc-release/
Donation: https://paypal.me/extremraym
Offline
User avatar

X-Raym

  • Posts: 152
  • Joined: Thu Apr 18, 2013 4:05 pm
  • Location: France
  • Real Name: Raymond Radet

PostFri Apr 11, 2025 11:25 am

Note: Resolve 20 beta 1 has the same readme as v19, so no update to push on the page.
My DaVinci Resolve Scripts: https://github.com/X-Raym/DaVinci-Resolve-Scripts
My Resolve Scripting API Doc: https://www.extremraym.com/en/resolve-api-doc-release/
Donation: https://paypal.me/extremraym
Offline
User avatar

X-Raym

  • Posts: 152
  • Joined: Thu Apr 18, 2013 4:05 pm
  • Location: France
  • Real Name: Raymond Radet

Re: DaVinci Resolve Scripting API Documentation - Custom Sty

PostSun Apr 27, 2025 12:20 pm

I didn't realize white theme wasn't that good, Fixed now

Note Resolve 20 beta 2 still has no update on script API.
My DaVinci Resolve Scripts: https://github.com/X-Raym/DaVinci-Resolve-Scripts
My Resolve Scripting API Doc: https://www.extremraym.com/en/resolve-api-doc-release/
Donation: https://paypal.me/extremraym

Return to Software Developers

Who is online

Users browsing this forum: No registered users and 5 guests