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.

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

Jump to bottom

Add Sphinx template #43

Merged
merged 5 commits into from
Oct 25, 2024
Merged

Add Sphinx template #43

merged 5 commits into from
Oct 25, 2024

Conversation

blink1073
Copy link
Contributor

No description provided.

@blink1073 blink1073 requested a review from Midnighter October 25, 2024 03:10
@blink1073 blink1073 changed the title Sphinx template Add Sphinx template Oct 25, 2024
sneakers-the-rat
sneakers-the-rat reviewed Oct 25, 2024
View reviewed changes
template/{% if documentation == 'sphinx' %}docs{% endif %}/index.rst.jinja Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

thoughts on using myst ubiquitously in the docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

lwasser
lwasser reviewed Oct 25, 2024
View reviewed changes
tests/test_template_init.py
@@ -49,6 +49,15 @@ def license(request: pytest.FixtureRequest) -> str:
return request.param


@pytest.fixture(
Copy link
Member

Choose a reason for hiding this comment

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

We can definitely merge this pr!! I just would love to better understand how this test template works. We can merge however without my understanding that and I can ask later as well!!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It creates versions of the test for each combination of inputs.

lwasser
lwasser approved these changes Oct 25, 2024
View reviewed changes
Copy link
Member

@lwasser lwasser left a comment

Choose a reason for hiding this comment

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

If everyone is good with this pr I certainly am!! please merge! THANK You for this. i can't believe how quickly this template came together and am so impressed by the team work involved in making it happen.

Midnighter
Midnighter approved these changes Oct 25, 2024
View reviewed changes
Copy link
Contributor

@Midnighter Midnighter left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for the quick work @blink1073.

I didn't check the sphinx config, since I have little experience with that.

What was your reason for dropping Python 3.9? It's still supported for another year. Anyway, I'm fine with doing so 🙂, it shouldn't obstruct a merge.

tests/test_template_init.py Outdated Show resolved Hide resolved
@blink1073
Copy link
Contributor Author

The recent major versions of Sphinx and myst_parser dropped support for Python 3.9.

@lwasser lwasser merged commit 82a518d into pyOpenSci:main Oct 25, 2024
6 checks passed
@blink1073 blink1073 deleted the sphinx-template branch October 27, 2024 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lwasser lwasser lwasser approved these changes

@Midnighter Midnighter Midnighter approved these changes

@sneakers-the-rat sneakers-the-rat Awaiting requested review from sneakers-the-rat

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@blink1073 @Midnighter @lwasser @sneakers-the-rat