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

Add inventory_cache arg to sphinx_runner #461

Closed
phlax opened this issue Apr 21, 2022 · 2 comments
Closed

Add inventory_cache arg to sphinx_runner #461

phlax opened this issue Apr 21, 2022 · 2 comments

Comments

@phlax
Copy link
Member

phlax commented Apr 21, 2022

Currently the sphinx_runner reads a config file in the Envoy/website repos and downloads the inventories on every docs build

It would be useful to add an inventory_cache arg that read from a directory and/or tarball to find the inventory files

this would allow bazel some control over how the inventories were fetched/found

in the case of the website the inventory files are present in the repo/workspace so they can be used directly

for Envoy, probably the best plan is to add them directly to the repo as they rarely change, but the challenge here is that we would then need CI to ensure this was up to date

one option would be to add a --strict-inventory-cache or similar that made sure that all/only the expected inventory files were present

@phlax
Copy link
Member Author

phlax commented Apr 25, 2022

Seems like this is not what is required. Sphinx config allows you to specify (multiple) sources for the objects.inv file so we can just specify and bundle the inventory files

What we do need is something to download (and maybe sync) the inv files

@phlax
Copy link
Member Author

phlax commented Apr 25, 2022

closed in favour of #462

@phlax phlax closed this as completed Apr 25, 2022
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

No branches or pull requests

1 participant