Skip to content

fix a bug in the .readthedocs.yml file #61

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.

Sign up for GitHub

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

Merged
ahms5 merged 5 commits into from
Apr 16, 2026
Merged

fix a bug in the .readthedocs.yml file #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d990b61
fixed the bug in the .readthedocs.yml file
h-chmeruk Apr 13, 2026
436ef94
Fixed indentation according to the review by @ahms5
h-chmeruk Apr 15, 2026
4598bb9
Applied changes from the review by @ahms5
h-chmeruk Apr 16, 2026
554c974
Added an if statement for the case where no apt_packages were specified
h-chmeruk Apr 16, 2026
c452dbd
Added a new test function to test the case when apt_packages is empty
h-chmeruk Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions template/.readthedocs.yml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ version: 2
build:
os: ubuntu-24.04
tools:
python: {{ latest_python_version }}
{% if 'libsndfile1' in apt_packages -%}
python: "{{ latest_python_version }}"
{%- if apt_packages != "" %}
apt_packages:
Copy link
Copy Markdown
Member

@ahms5 ahms5 Apr 15, 2026

Choose a reason for hiding this comment

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

Sorry, I did not see it earlier, I think we can loop through all apt_packages here in the list below. In this way every package in apt_packages will be installed, which is also the intended use.

- libsndfile1
{%- endif %}
{%- for package in apt_packages.split(',') %}
- {{ package.strip() }}
{%- endfor %}
{%- endif %}

{%- if add_submodules == true %}

Expand Down
14 changes: 12 additions & 2 deletions tests/test_copier.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,9 @@ def test_content_docs_multiple_files(default_project, file_name):


@pytest.mark.parametrize("desired", [
'- libsndfile1',
"python: 3.14",
' apt_packages:\n'
' - libsndfile1',
' python: "3.14"',
" include:\n - path/to/submodule",
])
def test_content_readthedocs(default_project, desired):
Expand All @@ -185,6 +186,15 @@ def test_content_readthedocs(default_project, desired):
assert desired in content


def test_apt_packages_empty(copie, copier_project_defaults):
project = copie.copy(extra_answers={**copier_project_defaults,
"apt_packages": ""})
content = project.project_dir.joinpath(
".readthedocs.yml").read_text()
not_desired = ' apt_packages:\n -'
assert not_desired not in content


@pytest.mark.parametrize("desired", [
'docs/resources/logos/pyfar_logos_fixed_size_my_project.png',
'your/custom/path/',
Expand Down