Skip to content

docs: fix Sphinx docstring formatting and reST syntax errors#195

Open
petercorke wants to merge 1 commit into
rai-opensource:masterfrom
petercorke:docs/sphinx-docstring-fixes
Open

docs: fix Sphinx docstring formatting and reST syntax errors#195
petercorke wants to merge 1 commit into
rai-opensource:masterfrom
petercorke:docs/sphinx-docstring-fixes

Conversation

@petercorke

Copy link
Copy Markdown
Collaborator
  • Fix LaTeX escaping in docstrings (add missing braces, convert to raw strings)
  • Correct reST indentation for documentation lists and notes
  • Fix code example imports and function references
  • Update cross-references using proper Sphinx format (:meth:, ~seealso:)
  • Fix parameter name references in docstrings (S→s, math.pi→np.pi)
  • Add missing type annotations in parameter documentation
  • Remove obsolete documentation files (classes-2d.rst, classes-3d.rst)
  • Improve reference formatting for external links

Fixes 19+ files with sphinx build warnings and documentation clarity issues. All changes are non-functional; improve rendering and consistency only.

- Fix LaTeX escaping in docstrings (add missing braces, convert to raw strings)
- Correct reST indentation for documentation lists and notes
- Fix code example imports and function references
- Update cross-references using proper Sphinx format (:meth:, ~seealso:)
- Fix parameter name references in docstrings (S→s, math.pi→np.pi)
- Add missing type annotations in parameter documentation
- Remove obsolete documentation files (classes-2d.rst, classes-3d.rst)
- Improve reference formatting for external links

Fixes 19+ files with sphinx build warnings and documentation clarity issues.
All changes are non-functional; improve rendering and consistency only.
@petercorke

Copy link
Copy Markdown
Collaborator Author

Note that classes-2d/3d.rst, shown as deleted, are orphaned documentation stub files. They were likely used for autodoc generation but are no longer referenced in the main documentation structure (not included in any .rst index or toctree).

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

2 participants