Cobertos / DoxygenMediawikiBot

A python bot using PyWikibot and Doxygen to put Doxygen docs onto a MediaWiki wiki
MIT License
2 stars 1 forks source link

Creates tables/lists with classnames, but no meaningful layout or working links #2

Closed peletiah closed 6 years ago

peletiah commented 6 years ago

After some fiddling I managed to get your bot to read and write doxygen-data, but the wiki-pages it creates only seem to be lists of classes and their methods, with broken wiki-syntax: [https://imgur.com/a/xXLGkJB](Screenshot of a typical page)

The docs that are exported to the tmp-directory by doxygen are looking good, they have working layout, links to classes and methods with parameters and the description. I was expecting a similar structure to be created in the wiki. But all the bot does is create tables with text as in the image above.

Before diving into the code myself - am I missing something or is that all it can do right now?

Cobertos commented 6 years ago

Hmm, it's been a long time since I wrote/used this so I'm only as useful as digging through the code myself as well. IIRC, it will create pages for every class and method (like normally comes out of Doxygen) and also adds MediaWiki categories to recreate the "list" type pages in Doxygen instead of trying to duplicate them as separate pages. It was supposed to handle the inheritance images (uploading and relinking them), tags, and some other stuff.

The basic process is as follows though (with links to source): At the highest level is basically generates the Doxygen docs as normal HTML, throws the doxygen HTML files of our choice into a DoxygenHTMLPage() which handles parsing and conversion, and then uploads it all the wiki.

peletiah commented 6 years ago

Ok, thanks for the pointers, I'll try to continue from there.

peletiah commented 6 years ago

I've now realized that it was simply the doxygen_filePrefixes in doxymw.py which didn't match my filenames. Now I get much more nicely formatted class-documentation, thanks!