Skip to content

Commit 71ebff4

Browse files
garyoclaude
andauthored
Fix/issue 229 doc links (#255)
* Fix dead documentation links in release-notes.md The header link block pointed at the long-removed /Guide tree and openeffects.org/documentation/* pages, all of which now 404. Use the same readthedocs links as README.md. Fixes #229. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Gary Oberbrunner <garyo@darkstarsystems.com> * Fix broken source-code links in Guide pages The per-example links to the sample sources pointed at the long-removed top-level Guide/ tree or at a nonexistent "doc" branch, so they 404 on readthedocs. Point them all at Documentation/sources/Guide/Code on main; verified every linked file exists there. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Gary Oberbrunner <garyo@darkstarsystems.com> --------- Signed-off-by: Gary Oberbrunner <garyo@darkstarsystems.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent e7316ce commit 71ebff4

6 files changed

Lines changed: 51 additions & 52 deletions

File tree

Documentation/sources/Guide/ofxExample1_Basics.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ with a host application, and goes into the fundamentals of the API.
66

77
An example plugin will be used to illustrate how all the machinery
88
works, and its source can be found in the C++ file
9-
`there <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Guide/Code/Example1/basics.cpp>`__.
9+
`there <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp>`__.
1010
This plugin is a *no-op* image
1111
effect and does absolutely nothing to images, it is there purely to show
1212
you the basics of how a host and plugin work together. I’ll embed
@@ -84,7 +84,7 @@ wants to keep them.
8484

8585
From our example, we have the following…
8686

87-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L343>`__
87+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L343>`__
8888

8989
.. code:: c++
9090

@@ -135,7 +135,7 @@ identify the plugin, what it does, and what version it is. These are:
135135

136136
Our example plugin’s ``OfxPlugin`` struct looks like…
137137

138-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L326>`__
138+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L326>`__
139139

140140
.. code:: c++
141141

@@ -221,7 +221,7 @@ called, but notice what it does…
221221

222222
.. _LoadActionExample:
223223

224-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L99>`__
224+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L99>`__
225225

226226
.. code:: c++
227227

@@ -281,7 +281,7 @@ Properties can be of the following fundamental types…
281281

282282
So for in our example we have….
283283

284-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L160>`__
284+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L160>`__
285285

286286
.. code:: c++
287287

@@ -353,7 +353,7 @@ well defined default for that action.
353353

354354
So looking at our example we can see its main entry point:
355355

356-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L259>`__
356+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L259>`__
357357

358358
.. code:: c++
359359

@@ -469,7 +469,7 @@ describe itself. This is done with the :c:macro:`kOfxActionDescribe` action. Fro
469469
our example plugin, here is the function called by our main entry point
470470
in response to the describe action.
471471

472-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L149>`__
472+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L149>`__
473473

474474
.. code:: c++
475475

@@ -535,7 +535,7 @@ in context action…
535535
them to show up in the same plugin group [4]_ in the user
536536
interface.
537537

538-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L171>`__
538+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L171>`__
539539

540540
.. code:: c++
541541

@@ -623,7 +623,7 @@ typically a hook to deeper plugin side data structures.
623623
that wants to write to the instance data after instance creation do
624624
so in a safe manner (e.g. by semaphore lock).
625625

626-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L202>`__
626+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L202>`__
627627

628628
.. code:: c++
629629

@@ -683,7 +683,7 @@ to its inputs, for example a blur effect with the blur size of zero. In
683683
such a case the host can simply ignore the plugin and use its source
684684
images directly. And here is the code that does that:
685685

686-
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example1/basics.cpp#L238>`__
686+
`basics.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example1/basics.cpp#L238>`__
687687

688688
.. code:: c++
689689

Documentation/sources/Guide/ofxExample2_Invert.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This guide will take you through the fundamentals of processing images
55
in OFX. An example plugin will be used to illustrate how it all works
66
and its source can be found in the C++ file
7-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Guide/Code/Example2/invert.cpp>`_.
7+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp>`_.
88
This plugin takes an image and
99
inverts it (or rather calculates the complement of each component).
1010
Ideally you should have read the guide to the :ref:`basic machinery of an OFX
@@ -21,7 +21,7 @@ total [1]_ and set very few switches.
2121
From the source, here is the main entry routine that traps those
2222
actions...
2323

24-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L416>`__
24+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L416>`__
2525

2626
.. code:: c++
2727

@@ -70,7 +70,7 @@ Describing Our Plugin
7070

7171
We have the standard two step description process for this plugin.
7272

73-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L117>`__
73+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L117>`__
7474

7575
.. code:: c++
7676

@@ -172,7 +172,7 @@ output image. If not set, it is up to the plugin to launch the
172172
appropriate number of threads and divide the processing appropriately
173173
across them.
174174

175-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L171>`__
175+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L171>`__
176176

177177
.. code:: c++
178178

@@ -361,7 +361,7 @@ address of a pixel in the image? Well you use the following information:
361361
The code snippet below shows you how to use all that to find the address
362362
of a pixel whose coordinates are on the image plane.
363363

364-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L216>`__
364+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L216>`__
365365

366366
.. code:: c++
367367

@@ -430,7 +430,7 @@ hosts and plugins.
430430
Anyway, here is code from our example using the property mechanism to
431431
get the required data from an image…
432432

433-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L242>`__
433+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L242>`__
434434

435435
.. code:: c++
436436

@@ -483,7 +483,7 @@ As stated above, the render action is the one used to get a plugin to
483483
actually process images. I’ll go through it in stages rather than have
484484
one big listing.
485485

486-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L310>`__
486+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L310>`__
487487

488488
.. code:: c++
489489

@@ -528,7 +528,7 @@ render window to fill in of the larger output image.
528528
that the plugin does not rely on any implicit state, such as time,
529529
everything is explicit.
530530

531-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L323>`__
531+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L323>`__
532532

533533
.. code:: c++
534534

@@ -543,7 +543,7 @@ render window to fill in of the larger output image.
543543
This next snippet fetches two clip handles by name from the instance,
544544
using the image effect suite. [2]_
545545

546-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L331>`__
546+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L331>`__
547547

548548
.. code:: c++
549549

@@ -571,7 +571,7 @@ We will be given back two property set handles which represent our
571571
images. If the call failed (which could be for a variety of good
572572
reasons) we give up with a ``throw``.
573573

574-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L345>`__
574+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L345>`__
575575

576576
.. code:: c++
577577

@@ -602,7 +602,7 @@ and output images will always have the same number of components and the
602602
same data types. Which is why we aren’t checking for the source for its
603603
pixel information.
604604

605-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L365>`__
605+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L365>`__
606606

607607
.. code:: c++
608608

@@ -630,7 +630,7 @@ correctly instantiate our templated function which will do the grunt
630630
work of iterating over pixels. Note also that it is passing the nominal
631631
maximum value of the data type as a template argument.
632632

633-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L383>`__
633+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L383>`__
634634

635635
.. code:: c++
636636

@@ -676,7 +676,7 @@ status.
676676

677677
Now for our pixel pushing code. [3]_
678678

679-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L242>`__
679+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L242>`__
680680

681681
.. code:: c++
682682

@@ -721,7 +721,7 @@ The first thing it does is to pull out the bounds, rowbytes and
721721
destination pointer of our two images. We can now iterate over the
722722
render window and set pixels in the output image.
723723

724-
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example2/invert.cpp#L273>`__
724+
`invert.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example2/invert.cpp#L273>`__
725725

726726
.. code:: c++
727727

Documentation/sources/Guide/ofxExample3_Gain.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This guide will take you through the basics of creating and using
55
parameters in OFX. An example plugin will be used to illustrate how it
66
all works and its source can be found in the C++ file
7-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Guide/Code/Example3/gain.cpp>`_.
7+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp>`_.
88
This plugin takes an image and
99
multiplies the pixel by the value held in a user visible parameter.
1010
Ideally you should have read the guide to the :ref:`basic image
@@ -82,7 +82,7 @@ Now seeing as we are going to be playing with parameters, our plugin
8282
will need a new suite, the parameters suite, and our load action now
8383
looks like:
8484

85-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L101>`__
85+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L101>`__
8686

8787
.. code:: c++
8888

@@ -136,7 +136,7 @@ is exactly the same as in the last example. What’s new is the bit where
136136
we describe parameters. I’ll show the describe in context action in
137137
several small chunks to take you through it.
138138

139-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L228>`__
139+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L228>`__
140140

141141
.. code:: c++
142142

@@ -179,7 +179,7 @@ new parameter’s property set handle. Each parameter has a set of
179179
properties we use to refine its behaviour, most of which have sensible
180180
defaults.
181181

182-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L278>`__
182+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L278>`__
183183

184184
.. code:: c++
185185

@@ -197,7 +197,7 @@ hairs over the image and so on. In this case we are saying that our
197197
double parameter represents a scaling value. OFX has more kinds of
198198
double parameter which you can use to best for your effect.
199199

200-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L282>`__
200+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L282>`__
201201

202202
.. code:: c++
203203

@@ -214,7 +214,7 @@ This section sets a default value for our parameter and a logical a
214214
minimum value below which it cannot go. Note it does not set a maximum
215215
value, so the parameter should not be clamped to any upper value ever.
216216

217-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L290>`__
217+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L290>`__
218218

219219
.. code:: c++
220220

@@ -236,7 +236,7 @@ values between 0.0 and 10.0 for our gain param, but the parameter could
236236
be set to a million via other means, eg: typing in a UI number box,
237237
animation, scripting whatever.
238238

239-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L298>`__
239+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L298>`__
240240

241241
.. code:: c++
242242

@@ -255,7 +255,7 @@ the parameter. It defaults to the name of the param, but it can be
255255
entirely different. Finally we set a hint string to be used for the
256256
parameter.
257257

258-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L308>`__
258+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L308>`__
259259

260260
.. code:: c++
261261

@@ -312,7 +312,7 @@ you can always grab parameters from an instance by name at any time. But
312312
to make our code a bit cleaner and to show an example of instance data
313313
being used, we are going to trap create instance.
314314

315-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L111>`__
315+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L111>`__
316316

317317
.. code:: c++
318318

@@ -333,7 +333,7 @@ handles, we are going to cache away handles to our clips and parameters
333333
in a simple struct. Note that these handles are valid for the duration
334334
of the instance.
335335

336-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L330>`__
336+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L330>`__
337337

338338
.. code:: c++
339339

@@ -378,7 +378,7 @@ in the instance’s property set.
378378
It then fetches handles to the two clips and two parameters by name and
379379
caches those into the newly created struct.
380380

381-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L123>`__
381+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L123>`__
382382

383383
.. code:: c++
384384

@@ -401,7 +401,7 @@ overloaded and there is another version that take an
401401
Of course we now need to trap the destroy instance action to delete our
402402
instance data, otherwise we will get memory leaks.
403403

404-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L364>`__
404+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L364>`__
405405

406406
.. code:: c++
407407

@@ -425,7 +425,7 @@ So we’ve define our parameters, we’ve got handles to the instance of
425425
them, but we will want to grab the value of the parameters to actually
426426
use them at render time.
427427

428-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L490>`__
428+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L490>`__
429429

430430
.. code:: c++
431431

@@ -465,7 +465,7 @@ similar to a C scanf function.
465465
And finally here is a snippet of the templated pixel pushing code where
466466
we do the actual processing using our parameter values;
467467

468-
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/doc/Documentation/sources/Guide/Code/Example3/gain.cpp#L437>`__
468+
`gain.cpp <https://github.com/AcademySoftwareFoundation/openfx/blob/main/Documentation/sources/Guide/Code/Example3/gain.cpp#L437>`__
469469

470470
.. code:: c++
471471

0 commit comments

Comments
 (0)