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

Doxygen build... #21967

Open
achsoftathome opened this issue Aug 17, 2022 · 4 comments
Open

Doxygen build... #21967

achsoftathome opened this issue Aug 17, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@achsoftathome
Copy link
Contributor

achsoftathome commented Aug 17, 2022

Hi, I made some modifications to allow the construction of the documentation ( doxygen) and I replace the logo by the one of Matter. The problem is induced by the symbolic links which are everywhere. They point to the root of the project, the tool enters in recursion...crash...
Could I make a pull request or pass these two files to someone in the project, tell me?

@bzbarsky-apple
Copy link
Contributor

@achsoftathome, you can absolutely make a pull request!

@bzbarsky-apple bzbarsky-apple added the documentation Improvements or additions to documentation label Aug 25, 2022
achsoftathome added a commit to achsoftathome/connectedhomeip that referenced this issue Aug 26, 2022
The Doxygen configuration file does not allow the generation of the documentation.

To solve this problem, I made some changes:
* I excluded symbolic links to avoid infinite recurrences.
* I excluded the "third_party" which causes too many troubles.

I disabled the transformation of the warning into an error because there's few warning during documentation generation.
I have deliberately not made any changes so as not to be too intrusive.
I invite the managers of these parts to make corrections that will certainly be more relevant than mine.
I put logs file on ticket.

Doc entry point: ./docs/html/index.html
Build command: CHIP_NAME="xxxx" CHIP_VERSION="v x.y.z" doxygen ./docs/Doxyfile
andy31415 pushed a commit that referenced this issue Aug 30, 2022
The Doxygen configuration file does not allow the generation of the documentation.

To solve this problem, I made some changes:
* I excluded symbolic links to avoid infinite recurrences.
* I excluded the "third_party" which causes too many troubles.

I disabled the transformation of the warning into an error because there's few warning during documentation generation.
I have deliberately not made any changes so as not to be too intrusive.
I invite the managers of these parts to make corrections that will certainly be more relevant than mine.
I put logs file on ticket.

Doc entry point: ./docs/html/index.html
Build command: CHIP_NAME="xxxx" CHIP_VERSION="v x.y.z" doxygen ./docs/Doxyfile
@andy31415
Copy link
Contributor

Also consider changes in #19950

Those were to large to allow for 1.0, however it shows a large update to our doc layout.

isiu-apple pushed a commit to isiu-apple/connectedhomeip that referenced this issue Sep 16, 2022
…ip#22180)

The Doxygen configuration file does not allow the generation of the documentation.

To solve this problem, I made some changes:
* I excluded symbolic links to avoid infinite recurrences.
* I excluded the "third_party" which causes too many troubles.

I disabled the transformation of the warning into an error because there's few warning during documentation generation.
I have deliberately not made any changes so as not to be too intrusive.
I invite the managers of these parts to make corrections that will certainly be more relevant than mine.
I put logs file on ticket.

Doc entry point: ./docs/html/index.html
Build command: CHIP_NAME="xxxx" CHIP_VERSION="v x.y.z" doxygen ./docs/Doxyfile
@stale
Copy link

stale bot commented Mar 7, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale Stale issue or PR label Mar 7, 2023
@bzbarsky-apple bzbarsky-apple removed the stale Stale issue or PR label Mar 7, 2023
@stale
Copy link

stale bot commented Oct 15, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale Stale issue or PR label Oct 15, 2023
@bzbarsky-apple bzbarsky-apple removed the stale Stale issue or PR label Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants