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.

Sign up for GitHub

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

Jump to bottom

doc: document make generate-* in related sections #14103

Merged
merged 4 commits into from
May 26, 2020
Merged

doc: document make generate-* in related sections #14103

merged 4 commits into from
May 26, 2020

Conversation

aabadie
Copy link
Contributor

@aabadie aabadie commented May 19, 2020

Contribution description

This PR is a follow-up of #8573 that documents the make generate-% targets in related sections:

  • writing an application => document make generate-example and make generate-test
  • porting a board => document make generate-board
  • driver guide => document make generate-driver
  • writing a module => document make generate-module

Testing procedure

Read the documentation

Issues/PRs references

Follows #8573

@aabadie aabadie added Area: doc Area: Documentation State: waiting for other PR State: The PR requires another PR to be merged first CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels May 19, 2020
@aabadie aabadie requested a review from fjmolinas May 19, 2020 16:15
@aabadie aabadie requested a review from jia200x as a code owner May 19, 2020 16:15
@aabadie aabadie mentioned this pull request May 19, 2020
Merged
@aabadie aabadie removed the State: waiting for other PR State: The PR requires another PR to be merged first label May 20, 2020
@aabadie aabadie added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label May 20, 2020
fjmolinas
fjmolinas reviewed May 26, 2020
View reviewed changes
Copy link
Contributor

@fjmolinas fjmolinas left a comment

Choose a reason for hiding this comment

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

Nice addition, but when I generate the documentation the module documentation doesn't generate properly, do you get that as well or is it on my side? (I've had issues with doxygen before)

@aabadie
Copy link
Contributor Author

aabadie commented May 26, 2020

do you get that as well or is it on my side?

It looks ok locally. But my Doxygen version is more recent than the one on Murdock/Docker. Not sure if that makes a difference.

@fjmolinas
Copy link
Contributor

Ok, @bergzand confirmed offline it generate Ok for him.

fjmolinas
fjmolinas approved these changes May 26, 2020
View reviewed changes
Copy link
Contributor

@fjmolinas fjmolinas left a comment

Choose a reason for hiding this comment

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

ACK.

@fjmolinas fjmolinas merged commit baeea44 into RIOT-OS:master May 26, 2020
@aabadie aabadie deleted the pr/doc/generator_doc branch May 26, 2020 10:37
@miri64 miri64 added this to the Release 2020.07 milestone Jun 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fjmolinas fjmolinas fjmolinas approved these changes

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees

@fjmolinas fjmolinas

Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs
Projects
None yet
Milestone
Release 2020.07
Development

Successfully merging this pull request may close these issues.
3 participants
@aabadie @fjmolinas @miri64