Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Online API documentation #154

Open
quinmars opened this issue Jun 20, 2020 · 0 comments
Open

Online API documentation #154

quinmars opened this issue Jun 20, 2020 · 0 comments

Comments

@quinmars
Copy link
Contributor

The UaClient library is missing an online API documentation. The goal should be that there is an up-to-date (in sync with the master branch) online documenation. With github pages and workflows, this shouldn't be too difficult to automate the generation and deployment. A github page already exists for opc-ua-client. One can choose from several documentation generation tools: sandcastle, docfx and wyam, to name some. I favor docfx, since it seems to be easy to setup and has a pleasant output. There already exists some github actions to automate the generation and deployment process, namely nikeee/docfx-action and maxheld83/ghpages
.

If you like, I'll try to setup the doxfx configuration and the CI integration.

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

No branches or pull requests

1 participant