-
Notifications
You must be signed in to change notification settings - Fork 2.1k
doc: move pkg/PORTING.md and pkg/USING.md to doxygen #4289
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
Conversation
Didn't you say that doxygen can parse markdown as well? |
It can parse it, yes. But it generates automatically pages for every new markdown file (named the name of the markdown file). We don't want this here, but just a module documentation. In detail: when adding a
I don't want this empty |
I see. |
A somewhat related configuration option I came across by accident: |
I saw this, too. But since PRs like #4285 will introduce further pages, I thought it to be less consistent. Additionally, the doxygen markdown still requires labels to be of any use to doxygen (Sub-sections in page tree, TOC, and ability to reference sections or pages from within doxygen). This isn't parsed however by GitHub properly (as well as the |
Rebased to current master |
@@ -758,6 +758,7 @@ INPUT = ../../doc.txt \ | |||
../../cpu \ | |||
../../boards \ | |||
../../drivers \ | |||
../../pkg \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
duplicate line
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed and squashed immediately
* | ||
* ~~~~~~~~ {.mk} | ||
* USEPKG += <pkg_name> | ||
* INCLUDE += $(RIOTBASE)/pkg/<pkg_name>/... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe INCLUDE += $(RIOTBASE)/pkg/<pkg_name>/<path to include directory>
could be even more explicit, or is that overkill?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that's overkill. Also the pkg
directory might be the include directory.
ACK and go! |
doc: move pkg/PORTING.md and pkg/USING.md to doxygen
Moves the documentation for packages to doxygen.