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

Remove doc build artifacts #308

Merged
merged 2 commits into from
Feb 8, 2024

Conversation

simondeziel
Copy link
Member

The files/dirs being removed:

$ du -sc /snap/lxd/current/share/lxd-documentation/{.buildinfo,objects.inv,_sphinx_design_static/,_sources/}
1	/snap/lxd/current/share/lxd-documentation/.buildinfo
18	/snap/lxd/current/share/lxd-documentation/objects.inv
49	/snap/lxd/current/share/lxd-documentation/_sphinx_design_static/
1162	/snap/lxd/current/share/lxd-documentation/_sources/
1229	total

Without the above, the UI and the builtin doc still worked fine.

@tomponline tomponline merged commit ccd35d4 into canonical:latest-edge Feb 8, 2024
2 checks passed
# not needed once built
rm doc/html/.buildinfo
rm -rf doc/html/_sphinx_design_static/
rm -rf doc/html/_sources/
Copy link

Choose a reason for hiding this comment

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

The sources are linked at the bottom of each page, so this will cause broken links in the footer.

Copy link
Member

Choose a reason for hiding this comment

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

@simondeziel ah dam, please can you revert.

Copy link

Choose a reason for hiding this comment

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

Alternatively, we could probably find some way to use a different footer for snap builds. Not sure if the sources are needed for everyone (I would like to keep them for the online docs and normal local build though, since they are very useful when working with the docs).

Copy link
Member

Choose a reason for hiding this comment

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

Can you link to the online ones always?

Copy link

Choose a reason for hiding this comment

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

This would be error-prone since the doc version shipped with the snap might differ from what is online - so the sources might not correspond to the documentation shipped with the snap.

Copy link
Member

Choose a reason for hiding this comment

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

So you're thinking just removing the link for offline version?

Copy link

Choose a reason for hiding this comment

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

Yes - or more precisely, for the docs that are shipped with the snap. We can control this by setting some environment variable for the snap build.

Copy link
Member

Choose a reason for hiding this comment

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

got it, makes sense, thanks

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for catching this @ru-fu. #313 stops removing those sources.

@simondeziel simondeziel deleted the smaller-doc branch February 8, 2024 14:24
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