python / python/cpython

pydoc HTML output is not responsive and has no viewport meta in released versions

オープン 初心者向け
#155,601 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

stdlib type-feature
主要言語
Python
スター
77.2k
フォーク
35.9k
PR マージ指標
PR 指標を取得中

説明

python -m pydoc -w generates standalone HTML pages for modules. The output is not usable on mobile:

  • The generated page has no tag in any released version (3.11-3.13). A viewport tag was added to the main branch only recently (Lib/pydoc.py), so it is not in any release yet.
  • Lib/pydoc_data/_pydoc.css contains no layout media queries at all; the only @media block is prefers-color-scheme: dark. The navigation sidebar and content are laid out with fixed widths, which overflows on narrow screens.

Related: #127276 ("Missing styles for pages created by a 'python -m pydoc -w' call", open) and #153906 (closed). This issue is specifically about the mobile/responsive behavior.

Expected: backport/keep a viewport meta tag in the generated HTML and add a max-width media query that stacks the sidebar above the content on narrow screens.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Lib/pydoc.py と Lib/pydoc_data/_pydoc.css から始め、その後モジュールに対して python -m pydoc -w を実行して生成されたページを確認します。完了条件は、リリースされた出力に viewport の meta タグが含まれ、狭い画面ではオーバーフローなしにナビゲーションがコンテンツの上に積み重なることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
css, python
領域
documentation, frontend
issue の種類
バグ
難易度
2/5
見積もり時間
1〜3時間
活発さ
静か
明瞭さ
明確に書かれている
初心者へのやさしさ
78/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。