Skip to content

Conversation

wthomason-bdai
Copy link
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.

@myeatman-bdai
Copy link
Collaborator

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

@wthomason-bdai
Copy link
Contributor Author

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

@wthomason-bdai
Copy link
Contributor Author

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

@myeatman-bdai
Copy link
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.

@wthomason-bdai
Copy link
Contributor Author

Shouldn't

git clone https://github.com/petercorke/spatialmath-python.git --branch gh-pages --single-branch gh-pages
cp -r docs/build/html/* gh-pages/
(or optionally the additional mkdir line before those two) make it work?

@myeatman-bdai
Copy link
Collaborator

oh, you're right. Derp.

@myeatman-bdai
Copy link
Collaborator

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

Copy link
Collaborator

@myeatman-bdai myeatman-bdai left a comment

Choose a reason for hiding this comment

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

👍

@myeatman-bdai
Copy link
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.

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