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

refactor: enable linting of docs/custom_conf.py #1330

Merged
merged 3 commits into from
Aug 23, 2024
Merged

refactor: enable linting of docs/custom_conf.py #1330

merged 3 commits into from
Aug 23, 2024

Commits on Aug 22, 2024

  1. Remove annotation referencing a type not in scope 

    It's not worth importing the type because this file is largely not type
hinted anyway.
    @james-garner-canonical
    james-garner-canonical committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    360345b View commit details
    Browse the repository at this point in the history

  2. Revert commit editing docs/conf.py 

    Changes should be made in docs/custom_conf.py where possible.

Enable custom_rst_epilog in docs/custom_conf.py (set to an empty string)
in lieu of removing rst_epilog from docs/conf.py (this commit restores
rst_epilog to docs/conf.py).

Remove global ruff: noqa directive for docs/conf.py -- ruff linting for
this file is already disabled in pyproject.toml
    @james-garner-canonical
    james-garner-canonical committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    aa7e9e7 View commit details
    Browse the repository at this point in the history

  3. Selectively disable linting for docs/custom_conf.py 

    Re-enable linting for docs/custom_conf.py (removing global noqa), but
selectively disable tests that fail, as much of this code is based on
sphinx-docs-starter-pack/custom_conf.py, which does not use the same
linting as this project.
    @james-garner-canonical
    james-garner-canonical committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    c3f4fad View commit details
    Browse the repository at this point in the history