Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix sphinx automation #162

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Fix sphinx automation #162

wants to merge 11 commits into from

Conversation

myeatman-bdai
Copy link
Collaborator

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

@myeatman-bdai
Copy link
Collaborator Author

@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.

@petercorke
Copy link
Collaborator

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

README.md Outdated
@@ -20,7 +20,7 @@
<td style="border:0px">
<img src="https://github.com/bdaiinstitute/spatialmath-python/raw/master/docs/figs/CartesianSnakes_LogoW.png" width="200"></td>
<td style="border:0px">
A Python implementation of the <a href="https://github.com/petercorke/spatial-math">Spatial Math Toolbox for MATLAB<sup>&reg;</sup></a>
A Python implementation of the <a href="https://github.com/bdaiinstitute/spatial-math">Spatial Math Toolbox for MATLAB<sup>&reg;</sup></a>
Copy link
Collaborator

@petercorke petercorke Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

revert, it refers to the MATLAB ancestor which is surely not at BDAI.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, sorry about that!

Copy link
Collaborator

@petercorke petercorke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@myeatman-bdai
Copy link
Collaborator Author

myeatman-bdai commented Jan 31, 2025

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
Copy link
Collaborator Author

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.

Copy link
Collaborator

@petercorke petercorke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants