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

Add theme #85

Merged
merged 12 commits into from
Sep 21, 2023
Merged

Add theme #85

merged 12 commits into from
Sep 21, 2023

Conversation

lilyminium
Copy link
Member

Fixes #84

Changes made in this Pull Request:

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG.md updated?
  • AUTHORS.md updated?
  • Issue raised/referenced?

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Missing the env file changes?

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Couple of questions, otherwise lgtm! Thanks!

@IAlibay
Copy link
Member

IAlibay commented Sep 8, 2023

Looking through the tests - do any of them actually test builds without MDAnalysis as the base org? I can't seem to find the full matrix anywhere.

@lilyminium
Copy link
Member Author

lilyminium commented Sep 10, 2023

@IAlibay the tests are Python tests, not options in CI -- the matrix is here:

@pytest.mark.parametrize("dependency_source", DependencyType)
@pytest.mark.parametrize("include_ReadTheDocs", ["y", "n"])
def test_write_outputs(

I initially verified the options by running the cookiecutter myself but I've added them in as tests now, which was good since the github options actually uncovered another bug.

I'll leave this open for another day or two in case you wanted to look at and comment on it -- I know you're busy, though, so no need to re-review if you don't have the time.

If you did want to re-review, I pushed updates from this PR to mdakit-cookie, e.g.:
https://github.com/MDAnalysis/mdakit-cookie/tree/TestMDAKit_with_host_MDAnalysis_condaforge-deps_and_ReadTheDocs with MDA as a host and https://github.com/MDAnalysis/mdakit-cookie/tree/TestMDAKit_with_host_other_condaforge-deps_and_ReadTheDocs . The corresponding docs are at https://mdakit-cookie.readthedocs.io/en/testmdakit_with_host_mdanalysis_condaforge-deps_and_readthedocs/ and https://mdakit-cookie.readthedocs.io/en/testmdakit_with_host_other_condaforge-deps_and_readthedocs/ .

@IAlibay
Copy link
Member

IAlibay commented Sep 11, 2023

Thanks, I'll have a look, might not get to it until tomorrow if it can wait - co-running a lot of NF sessions today.

@lilyminium
Copy link
Member Author

lilyminium commented Sep 11, 2023 via email

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Sorry about the slow review! Overall LGTM, there's just a couple of small questions but neither of which I consider to be necessary and/or blocking. (mostly curiosities)



# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# needs_sphinx = "1.0"
Copy link
Member

Choose a reason for hiding this comment

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

The theme requires a minimum of 6.2.1, do we want to set this here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, I've set it.

@pep8speaks
Copy link

pep8speaks commented Sep 21, 2023

Hello @lilyminium! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 186:80: E501 line too long (82 > 79 characters)

Line 27:21: E228 missing whitespace around modulo operator
Line 104:1: E122 continuation line missing indentation or outdented
Line 104:2: E225 missing whitespace around operator
Line 104:57: E225 missing whitespace around operator
Line 106:1: E122 continuation line missing indentation or outdented
Line 106:2: E225 missing whitespace around operator
Line 106:10: E225 missing whitespace around operator
Line 108:1: E122 continuation line missing indentation or outdented
Line 108:2: E225 missing whitespace around operator
Line 108:11: E225 missing whitespace around operator
Line 111:2: E228 missing whitespace around modulo operator
Line 111:58: E225 missing whitespace around operator
Line 115:2: E225 missing whitespace around operator
Line 115:11: E225 missing whitespace around operator
Line 163:80: E501 line too long (97 > 79 characters)
Line 173:80: E501 line too long (93 > 79 characters)
Line 184:80: E501 line too long (93 > 79 characters)

Comment last updated at 2023-09-21 09:03:23 UTC

@lilyminium lilyminium merged commit 5262269 into main Sep 21, 2023
11 checks passed
@lilyminium lilyminium deleted the switch-docs-theme branch September 21, 2023 09:45
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.

Switch to mdanalysis-sphinx-theme
3 participants