search

readthedocs / readthedocs.org

The source code that powers readthedocs.org
https://readthedocs.org/
MIT License
8.04k stars 3.58k forks source link

Add support for doxygen generated documentation? #3605

Closed Blendify closed 6 years ago

Blendify commented 6 years ago

This is just an idea but what do we think about supporting doxygen http://www.doxygen.org/ generated HTML. One issue I can see off the top of my head is that these types of projects can have large build times / size requirements (a couple Gb for a project for e.g.) But maybe this wont be an issue by the time we actually support this.

ericholscher commented 6 years ago

I think our goal is just to support Sphinx docs well for the forseeable future. Adding other backends adds a lot of complexity, which we've done before, and it's almost always a net loss in terms of value vs. complexity.

ericholscher commented 6 years ago

Pretty sure doxygen has sphinx integration though.

ericholscher commented 6 years ago

https://breathe.readthedocs.io/en/latest/

agjohnson commented 6 years ago

As far as I knew, breathe Just Worked.

I'd like to know what the support for breathe looks like with a modern version of our theme, if anyone knows of a project using both. I had a customer report that some of spacing on the breathe output looks wrong for them. This could be a Sphinx domain issue though, more likely.

Blendify commented 6 years ago

If I ever have free time I can try building our doxygen with breathe.

On Wed, Mar 7, 2018 at 5:37 PM, Anthony notifications@github.com wrote:

As far as I knew, breathe Just Worked.

I'd like to know what the support for breathe looks like with a modern version of our theme, if anyone knows of a project using both. I had a customer report that some of spacing on the breathe output looks wrong for them. This could be a Sphinx domain issue though, more likely.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/rtfd/readthedocs.org/issues/3605#issuecomment-371310470, or mute the thread https://github.com/notifications/unsubscribe-auth/AOeua8rqNPsIDxx1sI96IMvry8qO_M8tks5tcGEvgaJpZM4SETvr .

-- Aaron Carlisle

Picture taker | Bit cruncher | Pixel pusher | Document writer | Project administrator for the Blender 3D Documentation Project

agjohnson commented 6 years ago

I think breathe support is enough here. If not, I'm not sure when or if we'd get to supporting doxygen, so I suppose we can close this either way.