Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/bai 1475 python docs no longer work locally #1585

Merged
merged 4 commits into from
Oct 29, 2024

Conversation

JR40159
Copy link
Member

@JR40159 JR40159 commented Oct 23, 2024

No description provided.

@ghost
Copy link

ghost commented Oct 23, 2024

Would removing the static docs break our GitHub pages documentation.

https://gchq.github.io/Bailo/docs/python/index.html

Might need a pipeline to create the static docs?

@JR40159
Copy link
Member Author

JR40159 commented Oct 23, 2024

Would removing the static docs break our GitHub pages documentation.

https://gchq.github.io/Bailo/docs/python/index.html

Might need a pipeline to create the static docs?

Nope, we build the docs as part of our Github workflow: https://github.com/gchq/Bailo/blob/main/.github/workflows/web.yml#L46

@ghost
Copy link

ghost commented Oct 23, 2024

Tested and functions correctly, fixing the python docs issue when developing locally

@PE39806 PE39806 self-requested a review October 29, 2024 09:56
Copy link
Contributor

@PE39806 PE39806 left a comment

Choose a reason for hiding this comment

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

When running on my local machine, I still face Cannot GET /docs/python/index.html when trying to access the local Python docs. When execing into the backend docker image, I can see that /app/python-docs/dirhtml does not exist but /app/python-docs/_build/dirhtml does. This requires fixing.

Copy link
Contributor

@PE39806 PE39806 left a comment

Choose a reason for hiding this comment

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

Something went funky with caching in my docker containers. Re-cloning the repo, changing branches, pruning everything and then building has the docs working as expected.

@PE39806 PE39806 merged commit 8307deb into main Oct 29, 2024
15 checks passed
@PE39806 PE39806 deleted the bugfix/BAI-1475-python-docs-no-longer-work-locally branch October 29, 2024 13:33
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