Structure Sphinx documentation

Maintainers usually reply within 4 days

Assessment

Research direction

Description

Current Situation

The documentation hasn't been updated in a while. For example, the main structure of the documentation includes methods defined in the __init__.py files, which makes it look disorganised:

https://github.com/eclipse-basyx/basyx-python-sdk/blob/ef46fd889c4cb82a160c582cbcd55e4264eb5b05/sdk/basyx/aas/model/__init__.py#L44-L50

The current version of the documentation can be generated by navigating to docs via cd .\sdk\docs\ and executing .\make.bat html.

Proposed Change

Update the documentation and ensure that its structure is up to date. This is also an opportunity to check for accuracy, spelling mistakes, etc.

Getting set up

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.

More from eclipse-basyx/basyx-python-sdk

• README CI badge is broken

  Possibly taken A pull request linked to this issue is open or already merged. Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel
  bug documentation

  Difficulty 1/5 Under an hour Newbie friendliness 85/100

  eclipse-basyx/basyx-python-sdk#656 · Opened Oct 6, 2026

  Maintainers usually reply within 4 days

• Reject `limit=0` in paginated requests

  Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel
  bug server Specification

  Difficulty 2/5 1-3 hours Newbie friendliness 88/100

  eclipse-basyx/basyx-python-sdk#655 · Opened Oct 5, 2026

  Maintainers usually reply within 4 days

• sdk: `test_tutorials.py` is effectively no-op

  Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel
  bug sdk

  Difficulty 2/5 1-3 hours Newbie friendliness 84/100

  eclipse-basyx/basyx-python-sdk#634 · 3 comments · Opened Sep 18, 2026

  Maintainers usually reply within 4 days

• server: `ProtocolInformation`'s `securityAttributes` is missed in serialization

  Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel
  enhancement server

  Difficulty 2/5 1-3 hours Newbie friendliness 88/100

  eclipse-basyx/basyx-python-sdk#632 · Opened Sep 18, 2026

  Maintainers usually reply within 4 days

• server: `SubmodelDescriptor` serialization names `supplementalSemanticIds` wrong

  Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel
  bug high priority

  Difficulty 2/5 1-3 hours Newbie friendliness 90/100

  eclipse-basyx/basyx-python-sdk#631 · Opened Sep 18, 2026

  Maintainers usually reply within 4 days

All issues in eclipse-basyx/basyx-python-sdk

Similar issues

• [Task]: Prevent CSRF for `copy_push_notification`

  Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel
  effort: low prio: low ready

  Difficulty 2/5 1-3 hours Newbie friendliness 82/100

  digitalfabrik/integreat-cms#4616 · Opened Oct 13, 2026

  Maintainers usually reply within 5 days

• eval gate: an integer baseline score too large for a float raises OverflowError instead of a usage error (after #1779)

  Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel
  bug difficulty:2 good first issue help wanted

  Difficulty 2/5 1-3 hours Newbie friendliness 88/100

  MakazhanAlpamys/Soup#1865 · Opened Oct 13, 2026

  Maintainers usually reply within 1 day

• [UnvibeCode Engineering Challenge 2026 - Cohort 2 - Track 1] Secret redaction regex corrupts ordinary code in report snippets

  Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel

  Difficulty 2/5 1-3 hours Newbie friendliness 78/100

  FinanceFlash/unvibecode#233 · Opened Oct 13, 2026

  Maintainers usually reply within 1 day

• Write a short guide: using gknowledge with Claude Code

  Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel
  area: agents area: docs good first issue

  Difficulty 2/5 1-3 hours Newbie friendliness 88/100

  openapi/gknowledge#23 · Opened Oct 13, 2026

• useless-suppression reported for deprecated-* messages that should be exempt

  Possibly taken @adityasinha-ghub claimed this today. Open

  ⋯Report a problem with this issue

  • Is something wrong?

  • Already taken
  • Not beginner-friendly
  • Stale or invalid
  • Something else…
  • Send Cancel

  Difficulty 2/5 1-3 hours Newbie friendliness 88/100

  pylint-dev/pylint#11656 · Opened Oct 13, 2026

  Maintainers usually reply within 1 day

More Python issues