F Infrastructure: documentation - Githubissues

brightway-lca / brightway2

Metapackage for brightway2 imports and documentation

https://brightway.dev/

BSD 3-Clause "New" or "Revised" License

100 stars 37 forks source link

F Infrastructure: documentation #36

Open cmutel opened 2 years ago

cmutel commented 2 years ago

Documentation needs to be reworked and improved. A more decoupled organization of the Brightway 3 libraries should also make (new) contributions easier.

Specific tasks:

[x] F1 Develop new Sphinx template with a three column layout
[ ] F2 Reorganize documentation following the Diataxis framework for technical documentation
[ ] F3 Each notebook (where possible) should link to a try.brightway.dev container
[ ] F4 Develop, document, and test contribution guidelines and coding styles, and apply to all libraries