Skip to content

docs: re-run the gen code #1129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 25, 2025
Merged

docs: re-run the gen code #1129

merged 3 commits into from
May 25, 2025

Conversation

KazuCocoa
Copy link
Member

@KazuCocoa KazuCocoa commented May 24, 2025

Fixing the broken doc by flutter_integration

kazu $ make html
Running Sphinx v8.2.3
loading translations [en]... done
loading pickled environment... The configuration has changed (2 options: 'html_permalinks_icon', 'jquery_use_sri')
done
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] webdriver.extensions.flutter_integration
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:18: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:15: WARNING: Inline literal start-string without end-string. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:15: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:22: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:28: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:32: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:33: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:34: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:35: CRITICAL: Unexpected section title.

),
``` [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:40: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:47: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:48: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:52: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:56: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:58: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:68: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:72: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:74: ERROR: Unexpected indentation. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:76: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:77: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:78: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:79: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:80: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_commands.py:docstring of webdriver.extensions.flutter_integration.flutter_commands.FlutterCommand.get_render_tree:81: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
WARNING: autodoc: failed to import module 'flutter_finder' from module 'webdriver.extensions.flutter_integration'; the following exception was raised:
['Traceback (most recent call last):\n', '  File "/Users/kazu/.asdf/installs/python/3.12.4/lib/python3.12/site-packages/sphinx/ext/autodoc/importer.py", line 269, in import_object\n    module = import_module(modname, try_reload=True)\n             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n', '  File "/Users/kazu/.asdf/installs/python/3.12.4/lib/python3.12/site-packages/sphinx/ext/autodoc/importer.py", line 175, in import_module\n    module = importlib.import_module(modname)\n             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n', '  File "/Users/kazu/.asdf/installs/python/3.12.4/lib/python3.12/importlib/__init__.py", line 90, in import_module\n    return _bootstrap._gcd_import(name[level:], package, level)\n           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n', '  File "<frozen importlib._bootstrap>", line 1387, in _gcd_import\n', '  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load\n', '  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked\n', '  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked\n', '  File "<frozen importlib._bootstrap_external>", line 995, in exec_module\n', '  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed\n', '  File "/Users/kazu/github/python-client/appium/webdriver/extensions/flutter_integration/flutter_finder.py", line 23, in <module>\n    from appium.webdriver.common.appiumby import ByType as AppiumByType\n', "ImportError: cannot import name 'ByType' from 'appium.webdriver.common.appiumby' (/Users/kazu/.asdf/installs/python/3.12.4/lib/python3.12/site-packages/appium/webdriver/common/appiumby.py)\n"] [autodoc.import_object]
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying static files...
Writing evaluated template result to /Users/kazu/github/python-client/docs/_build/html/_static/basic.css
Writing evaluated template result to /Users/kazu/github/python-client/docs/_build/html/_static/language_data.js
Writing evaluated template result to /Users/kazu/github/python-client/docs/_build/html/_static/documentation_options.js
Writing evaluated template result to /Users/kazu/github/python-client/docs/_build/html/_static/js/versions.js
copying static files: done
copying extra files...
copying extra files: done
copying assets: done
writing output... [100%] webdriver.extensions.flutter_integration
generating indices... genindex py-modindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 25 warnings.

is now:

$ sh generate.sh
File /Users/kazu/github/python-client/docs/conf.py already exists, skipping.
Creating file /Users/kazu/github/python-client/docs/index.rst.
File /Users/kazu/github/python-client/docs/Makefile already exists, skipping.
File /Users/kazu/github/python-client/docs/make.bat already exists, skipping.
Running Sphinx v8.2.3
loading translations [en]... done
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 6 source files that are out of date
updating environment: [new config] 6 added, 0 changed, 0 removed
reading sources... [100%] webdriver.extensions.flutter_integration
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying static files...
Writing evaluated template result to /Users/kazu/github/python-client/docs/_build/html/_static/basic.css
Writing evaluated template result to /Users/kazu/github/python-client/docs/_build/html/_static/language_data.js
Writing evaluated template result to /Users/kazu/github/python-client/docs/_build/html/_static/documentation_options.js
Writing evaluated template result to /Users/kazu/github/python-client/docs/_build/html/_static/js/versions.js
copying static files: done
copying extra files...
copying extra files: done
copying assets: done
writing output... [100%] webdriver.extensions.flutter_integration
generating indices... genindex py-modindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

@KazuCocoa KazuCocoa marked this pull request as ready for review May 25, 2025 03:51
@KazuCocoa
Copy link
Member Author

let me try if this syntax fix will improve docs...

@KazuCocoa KazuCocoa merged commit 3457e49 into master May 25, 2025
12 checks passed
@KazuCocoa KazuCocoa deleted the docs branch May 25, 2025 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant