Fix Markdown docstrings to use RST-compatible formatting#798
Open
mendral-app[bot] wants to merge 1 commit into
Open
Fix Markdown docstrings to use RST-compatible formatting#798mendral-app[bot] wants to merge 1 commit into
mendral-app[bot] wants to merge 1 commit into
Conversation
|
PR author is not in the allowed authors list. |
mendral-app
Bot
force-pushed
the
mendral/fix-markdown-docstrings-rst-compat
branch
from
2688b92 to
1c26872
Compare
Replace triple-backtick code fences with RST indented code blocks (::) and Markdown blockquotes (>) with plain text notes across SDK source files. Also fix title underline lengths in docs/sphinx/index.rst. This resolves the docs-sdk-generate pre-commit hook failures caused by Sphinx/Napoleon being unable to parse Markdown syntax in docstrings. Affected files: - packages/notte-sdk/src/notte_sdk/client.py - packages/notte-sdk/src/notte_sdk/endpoints/sessions.py - packages/notte-sdk/src/notte_sdk/endpoints/agents.py - docs/sphinx/index.rst
mendral-app
Bot
force-pushed
the
mendral/fix-markdown-docstrings-rst-compat
branch
from
1c26872 to
7dd8496
Compare
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
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/sphinx/index.rsttitle underlines that were too short for their titlesChanges
Markdown → RST conversions across 3 SDK source files:
```python) with RST indented code blocks (Example::)>blockquotes with plain textNote:paragraphsNotteClient.scrape,RemoteSession.start,RemoteSession.stop,RemoteSession.page,RemoteSession.apage,RemoteSession.get_cookies,RemoteSession.scrape,RemoteSession.observe,RemoteSession.execute,RemoteAgent.run,AgentsClient.runRST title underline fix:
=underline-underlineValidation
Ran
cd docs && uv run sphinx-build -b mdx sphinx _buildlocally — build succeeded with zero errors/warnings.Context
Resolves insight: docs-sdk-generate pre-commit hook fails — the
docs-sdk-generatepre-commit hook was failing on every PR touching SDK source because Sphinx cannot parse Markdown syntax in docstrings.Note
Created by Mendral. Tag @mendral-app with feedback or questions.