Skip to content

FIX: Installing IPython when building RTD docs#388

Merged
Erotemic merged 2 commits into
pyutils:mainfrom
TTsangSC:doc-ipython
Aug 17, 2025
Merged

FIX: Installing IPython when building RTD docs#388
Erotemic merged 2 commits into
pyutils:mainfrom
TTsangSC:doc-ipython

Conversation

@TTsangSC

@TTsangSC TTsangSC commented Aug 16, 2025

Copy link
Copy Markdown
Collaborator

Right now the online docs for line_profiler.ipython_extension are empty, probably because IPython is not installed in the build environment and thus said module is unavailable at build time. Considering the recent efforts on improving said module (#383) and inquiries thereon (#382), it makes sense for its docs to at least be publicly accessible.

Hence, this PR updates .readthedocs.yml requirements/docs.txt so that ReadTheDocs build the doc pages with IPython installed, and autodocs can thus (presumably and hopefully) build the page for the aforementioned submodule.

@TTsangSC TTsangSC added the documentation Improvements or additions to documentation label Aug 16, 2025
@codecov

codecov Bot commented Aug 16, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.77%. Comparing base (60e928f) to head (1b34c4d).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #388      +/-   ##
==========================================
- Coverage   87.56%   86.77%   -0.80%     
==========================================
  Files          18       20       +2     
  Lines        1641     1920     +279     
  Branches      348      365      +17     
==========================================
+ Hits         1437     1666     +229     
- Misses        149      187      +38     
- Partials       55       67      +12     

see 6 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b3ce880...1b34c4d. Read the comment docs.

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

@Erotemic

Copy link
Copy Markdown
Member

Probably would make more sense to put:

-r ipython.txt

in requirements/docs.txt

@Erotemic Erotemic merged commit 3e357a2 into pyutils:main Aug 17, 2025
37 checks passed
@TTsangSC TTsangSC deleted the doc-ipython branch October 25, 2025 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants