Celery is a rather bad subproject example

[virtuald]

This has been bothering me for a few years now, but in the FAQ it calls out the celery/kombu projects as an example of subprojects. I suppose it's technically true, they are related projects, and they do use the subprojects functionality of RTD. But if you didn't know that kombu existed, you'd never be able to find it from the celery project.

I'd been contemplating using subprojects for awhile now, and my RobotPy project really suffered from the problem of having disconnected documentation sites... so last month I sat down and did some thinking, and I think I came up with a great solution that resulted in a unified set of subprojects that all mostly feel like they're the same site because they share the same sidebar/theme (and because of #1866, the search works across them all too! thanks!). Check it out:

• Main site: http://robotpy.readthedocs.io/
• Subproject 1: http://robotpy.readthedocs.io/projects/wpilib/
• ... and there are others

I also wrote a blog post on how I went about it, that could be useful to link to in the FAQ (or at least borrow the information/technique).

It would be good for others to have information on how to better use this useful feature. I can PR an edit to the FAQ if you aren't opposed to it -- if there are other/better/bigger examples to cite, that would be fine also.

[ericholscher]

This is a great idea. I agree that Celery isn't the best example, but there hasn't been a huge number of projects that would be good examples. Thanks for writing up all this stuff -- if you want to send over a docs patch, I'd love to include all the great work you're done!

[ericholscher]

We've also been thinking on some things that would let us integrate the menu TOC's and other bits from across subprojects -- so I'll definitely make sure to loop you in when we start working on that stuff.

[virtuald]

Cool, I'll try to find some time to put it together next week.

[ericholscher]

Would love to get this out, if you find time! 👍

[virtuald]

It is still on my calendar to do it, I just keep hitting 'delay 1 day'. :)

My work with FIRST Robotics keeps me super super busy until the end of February, but I will find time to do it.

[ericholscher]

🔘 Delay Thirty Days

😁

[virtuald]

It'll happen soon... 📆

[agjohnson]

Closing this due to inactivity. While the relationship between Celery and Kombu aren't obvious, it does at least illustrate our subproject feature. So, this change isn't entirely necessary unless someone wants to take this work on.