Skip to content

Conversation

@AndrewQuijano
Copy link
Collaborator

@AndrewQuijano AndrewQuijano commented Nov 24, 2025

Your checklist for this pull request

  • I've documented or updated the documentation of every API function and struct this PR changes.
  • I've added tests that prove my fix is effective or that my feature works (if possible)

Detailed description

Currently, the CI/CD is being used to update the docs.panda.re isn't working as intended.
...

Test plan

To test locally the same logic, try the following commands:

# Just to test locally, let's just have $HOME be our GITHUB_WORKSPACE.
GITHUB_WORKSPACE=$(echo $HOME)

# Replicate creating documents
git clone git@github.com:panda-re/panda-re.github.io.git --branch=master ${GITHUB_WORKSPACE}/auto_pydoc/pandare

# Create docs
docker run --rm -e PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python -v ${GITHUB_WORKSPACE}/auto_pydoc:/out pandare/pandadev:latest /bin/sh -c "pip3 install pdoc3==0.10.0; cd /panda/panda/python/core; pdoc3 --html --template-dir=../docs/template --force -o /out/ pandare;"

I updated the commands slightly, and when testing locally, it appears that there is no need to have a separate folder for each branch. See how, based on the screenshot, it seems like the pandare folder is correctly updated.

Finally, with @lacraig2's permission, I'm removing the alternate link to the x86-64 QCow download, as the link is no longer active.

Also, I realized this should have had a few more labels. I found that the issue was that I added './' when it wasn't needed.

image

...

Closing issues

N/A
...

@AndrewQuijano AndrewQuijano marked this pull request as ready for review November 24, 2025 23:06
@AndrewQuijano AndrewQuijano linked an issue Nov 25, 2025 that may be closed by this pull request
@AndrewQuijano AndrewQuijano changed the title Fix auto documentation CI/CD Fix CI/CD: Labeling and Auto-Documentation Nov 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

x86_64 dropbox link was deleted

2 participants