python / python/cpython

Missing styles for pages created by a 'python -m pydoc -w' call

Open
#127,276 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stdlib type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

When a user generates a documentation page via a 'python -m pydoc -w' call, the page has no style.
When a user executes 'python -m pydoc -n' or something similar, served HTML pages have links to CCS.

Maybe embedding default CCS into a generated page is a good idea?

Linked PRs
  • gh-127277

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with python -m pydoc -w and compare the generated page with HTML served by python -m pydoc -n. Review linked PR gh-127277 for the work already underway; done means generated documentation pages have the expected styling or stylesheet links.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.