← 返回首页
Remove broken gh-pages submodule by wthomason-bdai · Pull Request #172 · 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

Remove broken gh-pages submodule#172

Merged
myeatman-bdai merged 1 commit into
masterfrom
fix/remove-broken-submodule
Oct 7, 2025
Merged

Remove broken gh-pages submodule#172
myeatman-bdai merged 1 commit into
masterfrom
fix/remove-broken-submodule

Conversation

Copy link
Copy Markdown
Contributor

This PR removes the gh-pages directory, which appears to have been set up as a submodule, but has no definition in a .gitmodules file (as no such file is present). This misconfiguration causes problems adding spatialmath-python as a dependency to other projects using uv. If I'm wrong about gh-pages being necessary to keep around (e.g., if it somehow triggers the creation of a Github Page for the project?), then we'll need to find a different solution.

Copy link
Copy Markdown
Collaborator

Yeah, it looks like this used when generating documentation web pages, here

Copy link
Copy Markdown
Contributor Author

@myeatman-bdai Does that actually require the pseudo-submodule, though? Won't that command create the directory if missing?

Copy link
Copy Markdown
Contributor Author

(or, if not, we could add a mkdir -p gh-pages to that CI block?)

Copy link
Copy Markdown
Collaborator

I don't know much about gh-pages but I think that the git commands

git add . git commit -m "Update documentation" -a || true

won't work.

Copy link
Copy Markdown
Contributor Author

Shouldn't https://github.com/bdaiinstitute/spatialmath-python/blob/99fd55b8fefa3113fc7a6ea99e5b0232adb541a6/.github/workflows/sphinx.yml#L32-L33 (or optionally the additional mkdir line before those two) make it work?

Copy link
Copy Markdown
Collaborator

oh, you're right. Derp.

Copy link
Copy Markdown
Collaborator

Lets just merge this and see if the documentation generation still works.

myeatman-bdai 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

👍

Copy link
Copy Markdown
Collaborator

Per this yet to be merged PR #162, the sphinx automation is broken with or without this small changes, so we're going ahead and merging.

Hide details View details myeatman-bdai merged commit a29e647 into master Oct 7, 2025
15 of 16 checks passed
myeatman-bdai deleted the fix/remove-broken-submodule branch October 7, 2025 18:29
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.