Skip to content

Add proper documentation (user manual)#207

Merged
ralphlange merged 3 commits into
epics-modules:masterfrom
ralphlange:add-manual
Jun 19, 2026
Merged

Add proper documentation (user manual)#207
ralphlange merged 3 commits into
epics-modules:masterfrom
ralphlange:add-manual

Conversation

@ralphlange

Copy link
Copy Markdown
Member

This transforms the READMEs into proper Sphinx-based documentation.

  • Sphinx doc (readthedocs theme) with Diataxis structure
  • markdown with semantic line breaks
  • includes the Doxygen API documentation of the generic interfaces

- Migrate Using-Security.md and READMEs to proper Sphinx
- Configure Sphinx with ReadTheDocs theme and MyST parser
- Use Markdown with semantic line breaks
- Add versionadded markers for key features
- Organize content into Tutorials, How-to Guides,
  Reference and Explanation (Diataxis structure)

Co-authored-by: google-labs-jules[bot]
Co-authored-by: google-labs-jules[bot]
@ralphlange

Copy link
Copy Markdown
Member Author

See https://ralphlange.github.io/opcua/ for the result of this PR.
(This will work and install once merged.)

@ralphlange ralphlange merged commit 15372b1 into epics-modules:master Jun 19, 2026
12 of 23 checks passed
@ralphlange ralphlange deleted the add-manual branch June 19, 2026 07:38
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