FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-127276: add embedded styles to documentation pages created by a 'python -m pydoc -w' call by denisbukanov · Pull Request #127277 · python/cpython · GitHub

Repository navigation

gh-127276: add embedded styles to documentation pages created by a 'python -m pydoc -w' call - #127277

Open
denisbukanov wants to merge 2 commits into
python:mainfrom
denisbukanov:fix-issue-127276
Open

denisbukanov wants to merge 2 commits into
python:mainfrom
denisbukanov:fix-issue-127276

Conversation

denisbukanov commented Nov 26, 2024 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown

ghost commented Nov 26, 2024 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

bedevere-app Bot commented Nov 26, 2024

Copy link
Copy Markdown

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

Comment thread Lib/pydoc.py

def page(self, title, contents):
"""Format an HTML page."""
css_data = importlib.resources.files('pydoc_data').joinpath('_pydoc.css').read_text()

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Can this fail on any envs?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Ideally rhis should also be documented (i.e. you should say which file we are looking for). Maybe we can have a list of allowed files?

@@ -0,0 +1 @@
Add embedded styles to documentation pages created by a 'python -m pydoc -w' call

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I'm on mobile but this new feature warrants a What's New entry as well.

By the way, I'd suggest using back quotes to format the command line rather than single quotes as well as adding a period at the end of the sentence:

Allow to specify embedded styles for documentation pages created by :option:`pydoc -w`.

Please check that pydoc is documented as a program (with the .. program:: directive) and that -w is also a documented option (with the .. option:: directive). If not, you can just use

... created by the ``-w`` option of the :mod:`pydoc` program.

Comment thread Lib/pydoc.py

def page(self, title, contents):
"""Format an HTML page."""
css_data = importlib.resources.files('pydoc_data').joinpath('_pydoc.css').read_text()

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Ideally rhis should also be documented (i.e. you should say which file we are looking for). Maybe we can have a list of allowed files?

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review stale Stale PR or inactive for long period of time.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants


Back | FazBrowse Home | New Git URL