lua api docs urls

Software darktable
1

Similar to the new docs urls for darktable itself we prepared

Are those urls fine for you or do you want to structure this differently?

1 Like
2

@wpferguson please have a look

3

I think the only change I would make is from lua-api to just lua, since it’s now 3 manuals: scripts, scripts-api and lua-api. But, I can live with lua-api too.

As far as versioning, is master the current release version (API 7.0.0) or is master referring to current development master (API-8.0.0dev)? I think we can have a current that describes what’s currently released and a master (or API-x.x.x) to describe what’s in development master.

4
  1. we can rename the prefix easily.
  2. for the urls we followed the branches in the repo.

Current calling code looks like this:

#!/usr/bin/ruby
[snip]
DTLuaDocsBuilder.new(   
  "#{docs_base_url}/lua-api/8.0.0/", # full url
  'luadocs-8.0.0', # repo name
  'API-8.0.0', # branch
  "#{deploy_base_url}/lua-api/8.0.0/" # output path
)
    
DTLuaDocsBuilder.new(    
  "#{docs_base_url}/lua-api/master/",
  'luadocs-master',
  'master',
  "#{deploy_base_url}/lua-api/master/"    
)

so what kind of mapping you want?

5

@darix thanks for the code snippet. That makes it much clearer for me.

I think I should rename the API-8.0.0 branch to development. My current name scheme was creating a new API-x.x.x branch for each round of development, so that would require a code change to the deployment scripts. If I have 2 branches, master and development, then master contains the current release reference and development contains whatever we’ve changed. At release we just merge the development branch to master and start a new development branch. So using that scheme my proposal for naming is below:

#!/usr/bin/ruby
[snip]
DTLuaDocsBuilder.new(   
  "#{docs_base_url}/lua/development/", # full url
  'luadocs-development', # repo name
  'development', # branch
  "#{deploy_base_url}/lua/development/" # output path
)
    
DTLuaDocsBuilder.new(    
  "#{docs_base_url}/lua/master/",
  'luadocs-master',
  'master',
  "#{deploy_base_url}/lua/master/"    
)
6

TBH from an user standpoint i would make it /lua/development and /lua/stable

they do not care what the branch names are.

1 Like
7

stable is fine with me, let’s do it

8

well you need to change your branch names in git. or i will just map the api-8.0.0 branch to development.

9

API-8.0.0 renamed to development

10

JFYI the content is updated every 15 minutes directly from git, so if you want you can probably turn off the github pages stuff.

1 Like