Skip to content

potential fix to build and docs synchronization error#609

Merged
kevin-thankyou-lin merged 1 commit intoARISE-Initiative:masterfrom
Abhiram824:docs_pipeline_update
Jan 7, 2025
Merged

potential fix to build and docs synchronization error#609
kevin-thankyou-lin merged 1 commit intoARISE-Initiative:masterfrom
Abhiram824:docs_pipeline_update

Conversation

@Abhiram824
Copy link
Member

What this does

When building it looks like documentation pages have an error where the built docs are not the same as what is displayed on the website. For example, the webpage https://robosuite.ai/docs/simulation/device.html is empty despite the https://github.com/ARISE-Initiative/robosuite/blob/master/docs/simulation/device.rst having more information. I suspect this is due to the fact the built docs are being synchronized with the its parent directory: https://github.com/ARISE-Initiative/robosuite/blob/master/.github/workflows/update-docs.yaml#L44

I have updated the workflow to circumvent this issue, but I am not 100% sure if this is the cause/the changes I made are the solution (can't fully test locally).

How it was tested

Was able to replicate the error by running rsync -av --delete docs/_build/html/ docs/ and then bundle exec jekyll serve after building the docs and checking out to the gh_pages branch. I believe this is what the workflow does under hood.

@kevin-thankyou-lin
Copy link
Contributor

Awesome, changes look good to me.

@kevin-thankyou-lin kevin-thankyou-lin merged commit bb101c8 into ARISE-Initiative:master Jan 7, 2025
2 checks passed
@abhihjoshi
Copy link
Contributor

I think we may need to import hidapi to get the spacemouse related docs, that could be messing up the rest of the devices on this page.

X-jy-liu pushed a commit to X-jy-liu/robosuite that referenced this pull request Mar 5, 2025
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.

3 participants