spatialmath-python icon indicating copy to clipboard operation
spatialmath-python copied to clipboard

Published 20 hours ago • verified publisher icon bdaiinstitute

Fix sphinx automation

Open myeatman-bdai opened this issue 10 months ago • 4 comments

The workflow to generate sphinx documentation seems to not be working. Trying to fix that with this PR.

myeatman-bdai avatar Jan 30 '25 18:01 myeatman-bdai

@petercorke , it appears that the sphinx documentation workflow was dependent on a repo you had forked, sphinx-autorun (if I knew this I had forgotten). Some changes you made 3 weeks ago had a knock-on effect here. I've pinned the git hash in the automation to a previous version.

myeatman-bdai avatar Jan 30 '25 20:01 myeatman-bdai

I made some mods to speed it up, and change it to use project.toml, but that file is broken. Will look at that next

petercorke avatar Jan 30 '25 21:01 petercorke

I believe I have fixed the sphinx-auto problem, bad pyproject.toml file. It is probably a 100x faster now, but just go with what's most expedient for you. It has revealed quite a few execution errors in the example code blocks (the example blocks are wrong, not the toolbox), I will make a PR for these, but this shouldn't stop us publishing.

There are a few incorrect changes from petercorke to bdaiinstitute when referencing robotics toolbox, RVC book, MATLAB ancestor of this toolbox.

A lot of changes seem to be just trailing white space.

Sorry about that, I did a blanket replace of "github.com/petercorke" as a stab at figuring out what was going on with the sphinx stuff and thought I had reverted it already.

myeatman-bdai avatar Jan 31 '25 13:01 myeatman-bdai

A lot of changes seem to be just trailing white space.

I thought the black formatting PR I just merged would have also fixed this for all the files as well. I'll probably make one for that then.

myeatman-bdai avatar Jan 31 '25 14:01 myeatman-bdai