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

Add some documentation about generating the doxygen documentation #1496

Merged

Conversation

vivien-apple
Copy link
Contributor

Problem

People have hard time finding how to generate the documentation.

Summary of Changes

  • Add some documentation in building about generating the documentation.

fixes #1486

@vivien-apple vivien-apple force-pushed the Docs_AddDocumentationFoxDoxygen branch from a621fee to 9402bb0 Compare July 8, 2020 14:24
@vivien-apple vivien-apple requested a review from gerickson July 8, 2020 14:24
@woody-apple
Copy link
Contributor

@vivien-apple restyle :)

@vivien-apple
Copy link
Contributor Author

I think the restyle job failed in some ways:
stdoutCloning repository
stderrFrom https://github.com/project-chip/connectedhomeip
stderr * [new ref] refs/pull/1496/head -> pull-1496
stderrSwitched to branch 'pull-1496'
stdoutNo existing Restyled PR
stderrSwitched to a new branch 'restyled/pull-1496'
stdoutRestyling #1496
stdoutRestyling ["docs/BUILDING.md"] via "prettier-markdown"
stderrWARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.
stdoutdocs/BUILDING.md 247ms
stdout[restyled/pull-1496 3b4b689] Restyled by prettier-markdown
stdout 1 file changed, 3 insertions(+), 2 deletions(-)
stderrTo https://github.com/project-chip/connectedhomeip.git
stdoutSetting status of error for 9402bb0
stderr ! [remote rejected] restyled/pull-1496 -> restyled/pull-1496 (refusing to allow a GitHub App to create or update workflow .github/workflows/build.yaml without workflows permission)
stderrerror: failed to push some refs to 'https://@github.com/project-chip/connectedhomeip.git'
stderrWe had trouble running a system command:
stderr
stderr callProcess: git "push" "--force-with-lease" "origin" "restyled/pull-1496" (exit
stderr 1): failed

@woody-apple
Copy link
Contributor

I think the restyle job failed in some ways:
stdoutCloning repository
stderrFrom https://github.com/project-chip/connectedhomeip
stderr * [new ref] refs/pull/1496/head -> pull-1496
stderrSwitched to branch 'pull-1496'
stdoutNo existing Restyled PR
stderrSwitched to a new branch 'restyled/pull-1496'
stdoutRestyling #1496
stdoutRestyling ["docs/BUILDING.md"] via "prettier-markdown"
stderrWARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.
stdoutdocs/BUILDING.md 247ms
stdout[restyled/pull-1496 3b4b689] Restyled by prettier-markdown
stdout 1 file changed, 3 insertions(+), 2 deletions(-)
stderrTo https://github.com/project-chip/connectedhomeip.git
stdoutSetting status of error for 9402bb0
stderr ! [remote rejected] restyled/pull-1496 -> restyled/pull-1496 (refusing to allow a GitHub App to create or update workflow .github/workflows/build.yaml without workflows permission)
stderrerror: failed to push some refs to 'https://@github.com/project-chip/connectedhomeip.git'
stderrWe had trouble running a system command:
stderr
stderr callProcess: git "push" "--force-with-lease" "origin" "restyled/pull-1496" (exit
stderr 1): failed

Ugh, I'll take a look, thanks

@vivien-apple
Copy link
Contributor Author

Is there a command to just relaunch this job ?

@woody-apple
Copy link
Contributor

Is there a command to just relaunch this job ?

I think I need to fix ignore lists for restyled, I'll work on that this afternoon, sorry :(

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.

Make doc does not work
8 participants