Skip to content

Add submodule parameters to the template#62

Merged
ahms5 merged 5 commits intomainfrom
add-submodules-parameter
Apr 16, 2026
Merged

Add submodule parameters to the template#62
ahms5 merged 5 commits intomainfrom
add-submodules-parameter

Conversation

@h-chmeruk
Copy link
Copy Markdown
Contributor

This PR should cover the implementation of submodules introduced in the sofar package.

Changes proposed in this pull request:

  • Add new parameters to include submodules in the project.
  • Add submodule implementation to the files .circleci/config.yml, CONTRIBUTING.rst and .readthedocs.yml
  • Modify conftest.py and test_copier.py to check for the existence of the new content

@h-chmeruk h-chmeruk added this to the v0.1.0 milestone Apr 13, 2026
@h-chmeruk h-chmeruk added the enhancement New feature or request label Apr 13, 2026
@h-chmeruk h-chmeruk requested a review from ahms5 April 13, 2026 09:46
Copy link
Copy Markdown
Member

@ahms5 ahms5 left a comment

Choose a reason for hiding this comment

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

nice, thank you. I have a few ideas to make our live easier.

Comment thread template/.circleci/config.yml.jinja Outdated
- run:
name: Sphinx
command: |
{%- if add_submodules == true %}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

maybe add this as a separate block as done for the other ci jobs. Right now it is not that clean in sofar.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the review!
What exactly do you mean by a separate block? Could you please give an example?

Comment thread template/CONTRIBUTING.rst.jinja
Comment thread template/.readthedocs.yml.jinja Outdated
Comment thread copier.yml Outdated
@h-chmeruk h-chmeruk force-pushed the add-submodules-parameter branch from f0f4b71 to c83e6d7 Compare April 15, 2026 10:46
@h-chmeruk h-chmeruk requested a review from ahms5 April 15, 2026 11:06
Comment thread template/.circleci/config.yml.jinja Outdated
Comment on lines +95 to +101
- run:
name: Sphinx
command: |
{%- if add_submodules == true %}
git submodule sync --recursive
git submodule update --recursive --init
{%- endif %}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
- run:
name: Sphinx
command: |
{%- if add_submodules == true %}
git submodule sync --recursive
git submodule update --recursive --init
{%- endif %}
{%- if add_submodules == true %}
- run:
name: synchronize submodules
command: git submodule update --init --recursive && git submodule update --recursive --init
{%- endif %}
- run:
name: Sphinx
command: |

sth like this? now the Sphinx is just excecuting installing dependencies and excecute Sphinx

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Oh yes, you're right, that would look much better, and we have already used that block in other places in the file

@h-chmeruk h-chmeruk requested a review from ahms5 April 16, 2026 08:42
Copy link
Copy Markdown
Member

@ahms5 ahms5 left a comment

Choose a reason for hiding this comment

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

ready to merge

@ahms5 ahms5 merged commit de4749b into main Apr 16, 2026
11 checks passed
@ahms5 ahms5 deleted the add-submodules-parameter branch April 16, 2026 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants