prompt-toolkit / prompt-toolkit/python-prompt-toolkit

3.0.18: warning on generate prompt-toolkit man page

Open
#1,421 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

+ sphinx-build -b man -d prompt-toolkit docs .
Running Sphinx v3.5.3
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 23 added, 0 changed, 0 removed
reading sources... [100%] pages/upgrading/index
/home/tkloczko/rpmbuild/BUILD/prompt_toolkit-3.0.18/docs/pages/advanced_topics/index.rst:6: WARNING: toctree contains reference to nonexisting document 'pages/advanced_topics/unit_testing'
/home/tkloczko/rpmbuild/BUILD/prompt_toolkit-3.0.18/prompt_toolkit/application/__init__.py:docstring of prompt_toolkit.application.current.create_app_session:3: WARNING: Inline interpreted text or phrase reference start-string without end-string.
WARNING: autodoc: failed to import module 'pyperclip' from module 'prompt_toolkit.clipboard'; the following exception was raised:
No module named 'pyperclip'
/home/tkloczko/rpmbuild/BUILD/prompt_toolkit-3.0.18/prompt_toolkit/filters/base.py:docstring of prompt_toolkit.filters.base.Filter:1: WARNING: duplicate object description of prompt_toolkit.filters.Filter, other instance in pages/reference, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/prompt_toolkit-3.0.18/prompt_toolkit/filters/base.py:docstring of prompt_toolkit.filters.base.Condition:1: WARNING: duplicate object description of prompt_toolkit.filters.Condition, other instance in pages/reference, use :noindex: for one of them
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute EventLoop
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute From
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute Return
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute ensure_future
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute create_event_loop
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute create_asyncio_event_loop
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute get_event_loop
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute set_event_loop
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute run_in_executor
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute call_from_executor
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute run_until_complete
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute Future
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.eventloop, attribute InvalidStateError
WARNING: autodoc: failed to import module 'posix' from module 'prompt_toolkit.eventloop'; the following exception was raised:
No module named 'prompt_toolkit.eventloop.posix'
WARNING: autodoc: failed to import module 'win32' from module 'prompt_toolkit.eventloop'; the following exception was raised:
cannot import name 'windll' from 'ctypes' (/usr/lib64/python3.8/ctypes/__init__.py)
WARNING: autodoc: failed to import module 'asyncio_win32' from module 'prompt_toolkit.eventloop'; the following exception was raised:
No module named 'prompt_toolkit.eventloop.asyncio_win32'
WARNING: autodoc: failed to import module 'asyncio_posix' from module 'prompt_toolkit.eventloop'; the following exception was raised:
No module named 'prompt_toolkit.eventloop.asyncio_posix'
WARNING: autodoc: failed to import module 'win32' from module 'prompt_toolkit.input'; the following exception was raised:
No module named 'msvcrt'
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.output, attribute get_default_output
WARNING: missing attribute mentioned in :members: option: module prompt_toolkit.output, attribute set_default_output
WARNING: autodoc: failed to import module 'win32' from module 'prompt_toolkit.output'; the following exception was raised:
cannot import name 'windll' from 'ctypes' (/usr/lib64/python3.8/ctypes/__init__.py)
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-prompt_toolkit.3 { pages/gallery pages/getting_started pages/upgrading/index pages/upgrading/2.0 pages/upgrading/3.0 pages/printing_text pages/asking_for_input pages/dialogs pages/progress_bars pages/full_screen_apps pages/tutorials/index pages/tutorials/repl pages/advanced_topics/index pages/advanced_topics/key_bindings pages/advanced_topics/styling pages/advanced_topics/filters pages/advanced_topics/rendering_flow pages/advanced_topics/asyncio pages/advanced_topics/input_hooks pages/advanced_topics/architecture pages/advanced_topics/rendering_pipeline pages/reference } /home/tkloczko/rpmbuild/BUILD/prompt_toolkit-3.0.18/docs/pages/advanced_topics/key_bindings.rst:: WARNING: "table row spanning" not supported
/home/tkloczko/rpmbuild/BUILD/prompt_toolkit-3.0.18/docs/pages/advanced_topics/key_bindings.rst:: WARNING: "table row spanning" not supported
done
build succeeded, 29 warnings.

Contributor guide

No contributing guide indexed for this repository

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

Start by rerunning sphinx-build -b man -d prompt-toolkit docs . and review the warnings listed in the build output. Inspect docs/pages/advanced_topics/index.rst, docs/pages/advanced_topics/key_bindings.rst, and the referenced prompt_toolkit modules to determine which warnings are actionable. Done means the man-page build no longer reports the identified documentation and autodoc warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.