Skip to content

docs: Googlestyle docstrings and initial help sections#129

Open
vaeng wants to merge 5 commits into
masterfrom
googlestyle-docstrings
Open

docs: Googlestyle docstrings and initial help sections#129
vaeng wants to merge 5 commits into
masterfrom
googlestyle-docstrings

Conversation

@vaeng
Copy link
Copy Markdown
Collaborator

@vaeng vaeng commented May 8, 2026

I reworked all of the docstrings, the docs layout and structure and started with introduction texts, faq etc.

Also initial groundworks to test the examples and include them directly from the test files into the docs.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR modernizes and expands the documentation for the DeviceAccess Python bindings by converting many pybind11 docstrings to Google-style (Napoleon-compatible) docstrings, reorganizing the Sphinx docs into a more structured set of pages, and introducing an initial mechanism to source example snippets from executable test code.

Changes:

  • Updated pybind11 docstrings across multiple bindings to Google-style sections (Args/Returns/See Also/Raises) and improved API reference generation via Sphinx autosummary + napoleon.
  • Added new documentation pages (overview/getting started/user guide/examples/FAQ/troubleshooting) and refreshed the Sphinx configuration/theme.
  • Added initial “doc examples” tests and accompanying dummy map/dmap files intended for inclusion into docs via literalinclude.

Reviewed changes

Copilot reviewed 26 out of 45 changed files in this pull request and generated 22 comments.

Show a summary per file
File Description
tests/testDocExamples.py Adds executable example snippets intended to be included in Sphinx docs.
tests/documentationExamples/someDummyModule.map Dummy module map used by documentation examples/tests.
tests/documentationExamples/someCrate.dmap Dummy dmap used by documentation examples/tests.
src/RegisterCatalogue.cc Updates docstrings/args for RegisterCatalogue/RegisterInfo/DataDescriptor bindings.
src/PyVoidRegisterAccessor.cc Enhances docstrings and adds argument annotations for VoidRegisterAccessor bindings.
src/PyVersionNumber.cc Expands VersionNumber comparison/repr bindings and docstrings.
src/PyTwoDRegisterAccessor.cc Updates docstrings and adds arg annotations for 2D accessor bindings.
src/PyTransferGroup.cc Adds/expands TransferGroup docstrings and argument annotations.
src/PyScalarRegisterAccessor.cc Updates scalar accessor docstrings to Google style with See Also/Returns.
src/PyReadAnyGroup.cc Expands ReadAnyGroup/Notification docs and argument annotations.
src/PyOneDRegisterAccessor.cc Updates 1D accessor docstrings and adds __getattr__ docs/arg name.
src/PyDevice.cc Updates Device docstrings to Google style; reorganizes write() documentation.
src/PyDataType.cc Updates DataType docstrings to Google style.
src/PyDataConsistencyGroup.cc Improves DataConsistencyGroup docstrings and updates MatchingMode docs.
src/deviceaccessPython.cc Updates module-level docs; adds argument names and richer docstrings for core types.
pyproject.toml Adds a docs optional dependency group.
doc/*.rst Introduces new top-level docs pages and rewrites the docs landing/index structure.
doc/generated/*.rst Adds autosummary-generated API stubs for the reference section.
doc/conf.py.in Updates Sphinx setup (autosummary, typehints, intersphinx, RTD theme, import mocking).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tests/testDocExamples.py
Comment thread tests/testDocExamples.py
Comment thread tests/testDocExamples.py
Comment thread tests/testDocExamples.py
Comment thread tests/testDocExamples.py
Comment thread doc/faq.rst
Comment thread doc/faq.rst
Comment thread doc/mtca4u.rst Outdated
Comment thread doc/examples.rst Outdated
Comment thread tests/testDocExamples.py
@vaeng vaeng requested review from mhier and removed request for phako May 8, 2026 08:20
@vaeng vaeng force-pushed the googlestyle-docstrings branch from 565c79b to 2149e3d Compare May 9, 2026 06:57
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