← 返回首页
Fix sphinx automation by myeatman-bdai · Pull Request #162 · rai-opensource/spatialmath-python · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
Resetting focus

Fix sphinx automation#162

Open
myeatman-bdai wants to merge 11 commits into
masterfrom
fix-sphinx-automation
Open

Fix sphinx automation#162
myeatman-bdai wants to merge 11 commits into
masterfrom
fix-sphinx-automation

Conversation

Copy link
Copy Markdown
Collaborator

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

Copy link
Copy Markdown
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.

Copy link
Copy Markdown
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

Comment thread README.md Outdated
<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>

petercorke Jan 30, 2025
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

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

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Ah, sorry about that!

Comment thread README.md Outdated Show resolved Hide resolved
Comment thread README.md Outdated Show resolved Hide resolved
Comment thread docs/source/intro.rst Outdated Show resolved Hide resolved
Comment thread docs/source/intro.rst Outdated Show resolved Hide resolved
Comment thread README.md Outdated Show resolved Hide resolved

petercorke left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

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 commented Jan 31, 2025
edited
Loading

Copy link
Copy Markdown
Collaborator Author

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.

Copy link
Copy Markdown
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.

petercorke left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

This looks great, thanks

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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

Footer

© 2026 GitHub, Inc.