Skip to content

Comments

Add -draft to development hardware spec version#84

Merged
jonnew merged 1 commit intomainfrom
issue-83
Feb 24, 2025
Merged

Add -draft to development hardware spec version#84
jonnew merged 1 commit intomainfrom
issue-83

Conversation

@jonnew
Copy link
Member

@jonnew jonnew commented Feb 22, 2025

- Also some minor text changes and clarifications
@jonnew
Copy link
Member Author

jonnew commented Feb 22, 2025

@bparks13 For some reason these changes are not being reflected in the build artifact and I wonder if it has to do with the multi-version stuff.

@bparks13
Copy link
Member

@jonnew You are correct, this is related to the sphinx-multiversion extension. I documented this behavior in the README, with the relevant sentences copied here for convenience:

ONI/README.rst

Lines 94 to 102 in 9a50996

It is also important to note that if you
are working in a feature branch, it is not automatically pulled into the build
due to the branch whitelist found in the conf.py file. To test changes
that have been committed locally, add the current branch to the
``smv_branch_whitelist`` regular expression. For example, if the current working
branch is ``issue-XX``, then the new regular expression can be modified to be
"r'^(main|issue-XX)$'". Be sure to revert the changes to the conf.py file before
merging to main, otherwise the feature branch will be built in the online
version.

Basically, the build process for sphinx-multiversion is not governed by the local files themselves, but by the branches that are configured to be built. To test local changes, the local branch must be added to the build process.

To confirm, I added issue-83 to the whitelist to be built, which gave me the following build artifact:

image

@jonnew
Copy link
Member Author

jonnew commented Feb 24, 2025

Thanks, as per our discussion lets do the following: #85.

@jonnew jonnew merged commit 6e6e8e1 into main Feb 24, 2025
1 check passed
@jonnew jonnew deleted the issue-83 branch February 24, 2025 15:21
@jonnew jonnew mentioned this pull request Feb 24, 2025
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.

Give WIP spec version a "draft" suffix

2 participants