Skip to content

docs: resolve warnings - #849

Open
mcepl wants to merge 3 commits into
python-rope:masterfrom
openSUSE-Python:docs_warnings
Open

docs: resolve warnings#849
mcepl wants to merge 3 commits into
python-rope:masterfrom
openSUSE-Python:docs_warnings

Conversation

@mcepl

@mcepl mcepl commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Fixes these warnings:

> mitmanek~/r/r/docs (git: master)$ make html
Running Sphinx v8.2.3
loading translations [en]... done
[autosummary] generating autosummary for: configuration.rst, contributing.rst,
dev/issues.rst, index.rst, library.rst, overview.rst, release-process.rst, rope.rst
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 8 source files that are out of date
updating environment: [new config] 8 added, 0 changed, 0 removed
reading sources... [100%] rope
/home/matej/archiv/knihovna/repos/rope/rope/base/prefs.py:docstring of
rope.base.prefs.Prefs:1: WARNING: Inline emphasis start-string without end-string.
[docutils]
/home/matej/archiv/knihovna/repos/rope/rope/base/prefs.py:docstring of
rope.base.prefs.Prefs:1: WARNING: Inline emphasis start-string without end-string.
[docutils]
/home/matej/archiv/knihovna/repos/rope/rope/base/prefs.py:docstring of
rope.base.prefs.Prefs:1: WARNING: Inline emphasis start-string without end-string.
[docutils]
/home/matej/archiv/knihovna/repos/rope/docs/configuration.rst:73: WARNING: Title underline
too short.

imports.* Options
---------------- [docutils]
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying static files...
Writing evaluated template result to
/home/matej/archiv/knihovna/repos/rope/docs/_build/html/_static/basic.css
Writing evaluated template result to
/home/matej/archiv/knihovna/repos/rope/docs/_build/html/_static/documentation_options.js
Writing evaluated template result to
/home/matej/archiv/knihovna/repos/rope/docs/_build/html/_static/language_data.js
Writing evaluated template result to
/home/matej/archiv/knihovna/repos/rope/docs/_build/html/_static/js/versions.js
copying static files: done
copying extra files...
copying extra files: done
copying assets: done
writing output... [100%] rope
/home/matej/archiv/knihovna/repos/rope/docs/overview.rst:403: WARNING: Lexing literal_block
'def a_func():\n    a = 1\n    b = 2 * a\n    c = ${region_start}a * 2 + b *
3${region_end}' as "python" resulted in an error at token: '$'. Retrying in relaxed mode.
[misc.highlighting_failure]
/home/matej/archiv/knihovna/repos/rope/docs/overview.rst:424: WARNING: Lexing literal_block
'def a_func():\n    a = 1\n    ${region_start}b = 2 * a\n    c = a * 2 + b *
3${region_end}\n    print(b, c)' as "python" resulted in an error at token: '$'. Retrying
in relaxed mode. [misc.highlighting_failure]
/home/matej/archiv/knihovna/repos/rope/docs/overview.rst:1268: WARNING: Lexing
literal_block 'import mod1\n\narg = mod1.C1()\na_var =
mod1.func(arg)\na_var.${codeassist}\nmod1.func(mod1.C2()).${codeassist}' as "python"
resulted in an error at token: '$'. Retrying in relaxed mode. [misc.highlighting_failure]
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 7 warnings.

The HTML pages are in _build/html.
mitmanek~/r/r/docs (git: master)$

@codecov

codecov Bot commented Jul 25, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 81.48148% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.24%. Comparing base (dbc61cb) to head (b2f8c56).

Files with missing lines Patch % Lines
rope/base/fscommands.py 0.00% 4 Missing ⚠️
rope/refactor/move.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master     #849   +/-   ##
=======================================
  Coverage   95.24%   95.24%           
=======================================
  Files         134      134           
  Lines       26292    26292           
=======================================
  Hits        25043    25043           
  Misses       1249     1249           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR aims to eliminate Sphinx documentation build warnings and tidy up related quality-of-life issues across the repo, including doc rendering tweaks and small type-checking/formatting cleanups.

Changes:

  • Adjust documentation sources to avoid Sphinx/docutils warnings (fix a title underline; switch certain example blocks to non-highlighted code blocks; add a global Sphinx warning suppression).
  • Normalize # type: ignore comment formatting across several modules.
  • Update GitHub Actions workflow dependencies (checkout/setup-python/codecov) to newer major versions.

Reviewed changes

Copilot reviewed 8 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
rope/refactor/move.py Normalizes # type: ignore formatting for mypy-related comments.
rope/contrib/autoimport/sqlite.py Removes a stray whitespace-only line.
rope/base/project.py Normalizes # type: ignore formatting on imports.
rope/base/oi/type_hinting/providers/numpydocstrings.py Normalizes # type: ignore formatting around optional numpydoc import.
rope/base/oi/type_hinting/evaluate.py Normalizes # type: ignore formatting on decorators and definitions.
rope/base/oi/runmod.py Normalizes # type: ignore formatting around cPickle import fallback.
rope/base/oi/doa.py Normalizes # type: ignore formatting around cPickle/pickle imports.
rope/base/fscommands.py Normalizes # type: ignore formatting for optional VCS-related imports.
rope/base/ast.py Normalizes # type: ignore formatting around stdlib-private import.
docs/overview.rst Changes specific example blocks to code-block:: none to avoid highlighting failures due to placeholder tokens.
docs/configuration.rst Fixes section title underline length to satisfy docutils.
docs/conf.py Adds global Sphinx suppress_warnings configuration for docutils warnings.
.github/workflows/python-publish.yml Updates checkout/setup-python action major versions.
.github/workflows/main.yml Updates checkout/setup-python/codecov action major versions.
.github/workflows/codeql.yml Updates checkout action major version.
.github/workflows/black.yml Updates checkout action major version.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/conf.py
Comment on lines +69 to +71

# suppress third-party generated warnings
suppress_warnings = ["docutils"]
Comment on lines +16 to 20
- uses: actions/checkout@v7
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
uses: actions/setup-python@v7
with:
python-version: ${{ matrix.python-version }}
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.

2 participants