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

Check and lint sphinx configuration file doc/conf.py #630

Merged
merged 12 commits into from
Sep 23, 2020
Merged

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 22, 2020

Description of proposed changes

Run flake8 and pylint to check and lint doc/conf.py.

It would be easier to review each commit separately.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

@seisman seisman added the maintenance Boring but important stuff for the core devs label Sep 22, 2020
@seisman seisman added this to In progress in Release v0.2.x via automation Sep 22, 2020
@seisman seisman added this to the 0.2.1 milestone Sep 22, 2020
doc/conf.py Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@vercel vercel bot temporarily deployed to Preview September 23, 2020 02:25 Inactive
@weiji14
Copy link
Member

weiji14 commented Sep 23, 2020

Do you know much about the lint error?

doc/conf.py:8:0: E0611: No name 'sorting' in module 'sphinx_gallery' (no-name-in-module)

I can't reproduce it locally, but will update my dependencies and see what's up with that.

@seisman
Copy link
Member Author

seisman commented Sep 23, 2020

Can't reproduce it with pylint 2.5.3, but CI uses pylint 2.6.0.

@vercel vercel bot temporarily deployed to Preview September 23, 2020 02:50 Inactive
@weiji14
Copy link
Member

weiji14 commented Sep 23, 2020

Can't reproduce it with pylint 2.5.3, but CI uses pylint 2.6.0.

Nope, passes locally for me on pylint 2.6.0 too. Couldn't find anything relevant in the changelog at http://pylint.pycqa.org/en/latest/whatsnew/changelog.html#what-s-new-in-pylint-2-6-0 since we upgraded to pylint 2.5 a few months ago at #484

@vercel vercel bot temporarily deployed to Preview September 23, 2020 03:59 Inactive
@seisman
Copy link
Member Author

seisman commented Sep 23, 2020

When I try to import an non-existent module like from sphinx_gallery.foobar import FileNameSortKey, I get the same pylint error. It makes sense to me, because pylint can check the available modules of sphinx_gallery. However, sphinx_gallery is not installed in the Style Checking CI. Perhaps it's simply because sphinx_gallery is not installed.

@seisman seisman merged commit 4e7e28b into master Sep 23, 2020
Release v0.2.x automation moved this from In progress to Done Sep 23, 2020
@seisman seisman deleted the update-doc branch September 23, 2020 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants