search

brightway-lca / cookiecutter-brightwaylib

A cookiecutter based project template for brightway libraries.
MIT License
1 stars 3 forks source link

Documentation Template Upgrade #42

Closed michaelweinold closed 6 months ago

michaelweinold commented 6 months ago

Hello there!

I made some modifications to the documentation template. This aligns the docs infrastructure with the main docs repo.

For a preview, please check out the modifications I just made to the bw_graph_tools repo:

With this minimal set of Sphinx extensions, I feel comfortable not pinning versions.

Feedback appreciated.

michaelweinold commented 6 months ago

(I did not test the template yet (merging into main without testing gives me the thrill I need mid-week)

cmutel commented 6 months ago

Sorry, these changes are the same as the ones you already tried at e.g. bw_graph_tools, right? So they have been tested there? I don't think we really need to create a fake library with fake documentation just to test something which can be easily patched in any case...

cmutel commented 6 months ago

I don't understand how this can have merge conflicts given the branch and main commit histories!?

michaelweinold commented 6 months ago

Most of what's here has been tested. But it would be nice to see what all the different {{ variables }} resolve to. I'll try tomorrow. I would also suggest we keep this in draft state until I have actually added all the remaining code.

michaelweinold commented 6 months ago

I don't understand how this can have merge conflicts given the branch and main commit histories!?

No idea - VS Code does not show any conflicts. In any case, this I will squash tomorrow.