About the generated Document html files

[asmwarrior]

Hi, @GitHubLionel and @DRNadler

Currently, there are a folder named Doc in the code repo.

This folder contains a lot of doxygen generated html files.

My suggestion is that the document html file could put in a standalone site, not in the code repo. So that the document and the code can be synchronized very easily.

Any ideas?

[DRNadler]

This is a frequent problem on github. Publishers want it easy for folks to review documentation without too much effort.

Most important is to improve documentation, which is currently not good.

[DRNadler]

Try this: https://codedocs.xyz/DRNadler/wxMathPlot_take2/
I added a pull request adding the .codedocs configuration file.

[asmwarrior]

Try this: https://codedocs.xyz/DRNadler/wxMathPlot_take2/ I added a pull request adding the .codedocs configuration file.

Hi, good work, the site works very well.

[DRNadler]

Except missing diagrams and old version of DOxygen - aarrrggg...
I've posted to GitHub and contacted xyz's author, we'll see if it ever gets fixed ;-(

[asmwarrior]

The diagrams are still showing badly, for example:

https://codedocs.xyz/GitHubLionel/wxMathPlot/class_math_plot_1_1mp_f_x_y.html

[DRNadler]

https://github.com/orgs/community/discussions/137874#discussioncomment-10561970

I tracked down the codedocs.xyz author; he told me he's too busy to maintain the site even though it just needs loading Graphviz and the latest Doxygen...

[asmwarrior]

Maybe, we can try this kind of github action automatically?

see this: DenverCoder1/doxygen-github-pages-action: GitHub Action for deploying Doxygen documentation to a GitHub pages branch

[DRNadler]

Give it a try!

[asmwarrior]

I'm not very familiar with the github action, but recent days, I have learned how to build a full Code::Blocks release package from the source totally in github action, see here: https://github.com/asmwarrior/x86-codeblocks-builds

So, I believe using the github action to build the doxygen generated html is also available.

In the future, I think we can even use github action to build a demo wxMathPlot project, so people can download it and run it in their PC.

[DRNadler]

See if you can add Doxygen and Graphviz to your github action installation list and run them...

[asmwarrior]

See if you can add Doxygen and Graphviz to your github action installation list and run them...

Well, my guess the doxygen and graphviz tools are a bit different than the traditional C++ compiler in the github action. I haven't tried anything yet about those tools.

EDIT:

Also, I haven't tried to build a personal site myself yet in github.

[DRNadler]

Try adding them to your existing action...