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

No more pre-building by-default, switching to recursive builds #77

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

devanshshukla99
Copy link
Owner

@devanshshukla99 devanshshukla99 commented Mar 21, 2024

❌ stalled until branches can be selected via conf.py


The package, currently, first prebuilds all branches and tags via vanilla sphinx in an isolated location and then builds all the specified branches/tags via the sphinx-versioned-docs extension.
This may work for small projects, however, as the number of branches increases along with the project size, a more reasonable approach will be to build all branches with sphinx-versioned-docs and if any fails then initiate the building workflow for all branches except the failed ones.

This recursive approach will improve build times.
Branches to be ignored can be specified via --branch arg as mentioned in #69
 
(If any branch build fails then the building workflow is re-initated for all branches except the failed one. Pre-building can still be enabled via --prebuild cli arg.)

  • Build tests passed
  • Codestyle tests passed
  • Added test coverage for new features
  • Documentation updated to reflect the changes

If any branch build fails then the building workflow is re-initated for all branches except the failed one.
Pre-building can still be enabled via `--prebuild` cli arg.
@devanshshukla99 devanshshukla99 changed the title No more pre-building switching to recursive builds No more pre-building by default switching to recursive builds Mar 21, 2024
@devanshshukla99 devanshshukla99 changed the title No more pre-building by default switching to recursive builds No more pre-building by-default, switching to recursive builds Mar 21, 2024
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.

1 participant