Project

Profile

Help

Bug #5822

closed

Main Python API is online at https://www.saxonica.com/saxon-c/doc12/html/saxonc.html but relative links link to e.g. saxoncee.html#PyDocumentBuilder and saxoncee.html is not online

Added by Martin Honnen about 1 year ago. Updated 11 months ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Start date:
2023-01-16
Due date:
% Done:

100%

Estimated time:
Found in version:
12
Fixed in version:
12.2
Platforms:

Description

The online SaxonC Python API documentation seems kind of broken, I am directed to https://www.saxonica.com/saxon-c/doc12/html/saxonc.html as the overview document but that contains links like

<a href="saxoncee.html#PyDocumentBuilder">PyDocumentBuilder</a>

and the saxoncee.html leads to a 404.

Actions #1

Updated by O'Neil Delpratt about 1 year ago

  • Assignee changed from O'Neil Delpratt to Debbie Lockett

Thanks for spotting this. There seems to be some confusion with the generation of the documentation: saxonc.html vs saxoncee.html We will investigate this further.

Actions #2

Updated by Norm Tovey-Walsh about 1 year ago

Yes. The move from saxonc to saxoncee, saxoncpe, and saxonche in the 11th hour had some knock on effects. I believe we casually rename saxoncee.html to saxonc.html during the doc build because it simplified some other parts of the build. It'll have to be fixed one way or another.

Actions #3

Updated by Debbie Lockett about 1 year ago

I've fixed the online SaxonC Python API doc, so the internal links are correct.

Fixing the doc build itself is in progress.

Actions #4

Updated by Debbie Lockett about 1 year ago

  • Status changed from New to In Progress
Actions #5

Updated by Debbie Lockett about 1 year ago

I've committed a change in the docs build script which hopefully fixes the issue by correcting all the links (by replacing "saxoncee.html" with "saxonc.html"). I haven't been able to check it because I can't currently build the python API docs.

Actions #6

Updated by Debbie Lockett 11 months ago

  • Status changed from In Progress to Resolved

Closing this now, I think we're happy that we've fixed the problem.

Actions #7

Updated by O'Neil Delpratt 11 months ago

  • Status changed from Resolved to Closed
  • % Done changed from 0 to 100
  • Fixed in version set to 12.2

Bug fix applied in the SaxonC 12.2 maintenance release.

Please register to edit this issue

Also available in: Atom PDF