Skip to content

Add pkgdown website - #139

Open
PietrH wants to merge 5 commits into
mainfrom
138-create-pkgdown-website
Open

Add pkgdown website#139
PietrH wants to merge 5 commits into
mainfrom
138-create-pkgdown-website

Conversation

@PietrH

@PietrH PietrH commented Apr 7, 2026

Copy link
Copy Markdown
Member

There has been a request for swagger documentation for the OpenCPU API. This is not trivial to generate for OpenCPU (unlike plumber).

We can however add a pkgdown website that includes more information on how to adress the etn OpenCPU API. This PR is a first step towards this.

The current function documentation of etnservice is largely still old etn documentation.

@PietrH PietrH linked an issue Apr 7, 2026 that may be closed by this pull request
@PietrH PietrH changed the title usethis::use_pkgdown() Add pkgdown website Apr 7, 2026
@PietrH PietrH self-assigned this Apr 7, 2026
@PietrH
PietrH requested a review from peterdesmet April 7, 2026 14:29
@PietrH
PietrH marked this pull request as ready for review April 7, 2026 14:31

@peterdesmet peterdesmet left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good to have a website. Did not check output.

See comments for two suggestions for the NEWS.md

Comment thread NEWS.md
@@ -1,4 +1,5 @@
# etnservice (development version)
- etnservice now has a pkgdown website: [inbo.github.io/etnservice/](https://inbo.github.io/etnservice/).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would either:

  • Link pkgdown website
  • Write the URL as <https://inbo.github.io/etnservice/>

Also useful to add the PR number at the end in (139) before the closing .

Comment thread _pkgdown.yml

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Curious that usethis places this still in the root, rather than pkgdown/_pkgdown.yml (cf. https://github.com/inbo/etn/tree/main/pkgdown)

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.

Create pkgdown website

2 participants