Add new Brightway Documentation Page to pydata-sphinx Example Gallery

[michaelweinold]

Dear pydata-sphinx-theme devs - many thanks for your hard work on this fantastic theme!

Our documentation has left the testing phase - we would be happy to add it to your "gallery of sites using this theme" page.

This follows up on #1119 and closes brightway-lca/brightway-documentation#44.

[12rambau]

Needs discussion, see #1121

[michaelweinold]

@12rambau, I see - fair enough.

From what I can see (quick sample of some sites featured in the gallery), ours is currently the only project using git submodules (+GitHub Actions) extensively. It took quite a while to set up, but we now have a rather neat setup, which is explained in detail in the Contribution Guide: API Documentation.

I am certain this would be useful to projects looking to include docstrings from multiple repos in their API documentation. Despite the obvious advantages of a monorepo, some communities won't be able to give up distributed repos anytime soon.

Ultimately, we just want to help pydata-sphinx-theme users avoid having to set this up all over again. I'm not sure we would benefit from the 'advertising space' (cf. #1121 (comment)) so much 😎

Let us know what you think!

[12rambau]

I fully agree we just wait for #1221 to be closed before merging any new item in the list as the structure of the list itself may change.

I would like to make it clearer what make each example "special" so that reader can look at them for demo purposes.

[michaelweinold]

@12rambau, I see that #1221 has now been closed. Could we go ahead with the merge?

[drammock]

@12rambau, I see that #1221 has now been closed. Could we go ahead with the merge?

the relevant issue is #1121 not #1221

[12rambau]

@michaelweinold, thanks for your patience, would you mind updating your branch so that brightway get into the list ? Note that you should set your site in alphabetical order.

[michaelweinold]

Whops, just wanted to sync my branch. Hold on...

[michaelweinold]

Thank you for the update, @12rambau. I have added Brightway to the Other projects using this theme section for now. As I mentioned ealier (#1232 (comment)), we do have some nice customization around GH Actions, a GH App for automation and git submodules. If, in your opinion, this warrants inclusion in the Featured projects section, I'll happily move it there.

[12rambau]

We are a bit behind schedule for many other issues preventing us from releasing. let's leave your project where it is for now and we'll see about the promotion to feature in a second time.

I'm merging this PR so that you appear in latest !