Are the docs broken?

[aringot]

Hi, I wanted to understand how to use Brightway and feel like the docs are broken.

When I go to https://documentation.brightway.dev/en/latest/index.html the only link that is working is the API reference.

Am I missing something? How do I get to explanations and tutorials? (I did find some Jupyter Notebooks that gave me an idea of how using Brightway IO looks like, but I would like more background on the concepts used)

Thanks!

[cmutel]

@michaelweinold I assume you know about this already 😛

The sections LCA and Gallery are currently broken. The learn.brightway.dev has a certificate problem - is this hosted on our server? I can change the DNS settings as needed, just let me know.

[michaelweinold]

Hey, @aringot!

I feel like the docs are broken.

We are hosting the documentation on readthedocs.org. This morning, the fine folks of their development team helped me resolve an issue that I discovered, which affected all users of their platform (cf. readthedocs/readthedocs.org#10477).
As part of this fix/upgrade, I managed to break a few pages (which you noticed). It's all fixed now - just refresh your browser.

How do I get to explanations and tutorials?

At this time, you can look through this collection of Jupyter Notebooks that we use for teaching: brightway-lca/from-the-ground-up.

In the near future (to be discussed with @cmutel), we'll have a separate repository to collect Brightway examples and tutorials.

I would like more background on the concepts used

I would recommend this section of the documentation: LCA

[aringot]

@michaelweinold thanks for the detailed explanation! Fyi, the links on the left side still seem to be broken (e.g. LCA links to source/lca/index.html instead of content/lca/index.html) and I still get the certificate issue for learn.brightway.dev.

Another thing I noticed is that something weird happened on some headings (might be an old HTML anchor?):
Exchange data format {#exchanges}

[michaelweinold]

Another thing I noticed

As the page indicates at the very top:

Feel free to open a PR to fix these artefacts - otherwise they won't go away 😎

I have a few broken links on the radar (cf. #95). learn.brightway.dev is still under construction.

[tngTUDOR]

@michaelweinold I assume you know about this already stuck_out_tongue

The sections LCA and Gallery are currently broken. The learn.brightway.dev has a certificate problem - is this hosted on our server? I can change the DNS settings as needed, just let me know.

@cmutel where is this supposed to point to anyway ? I don't see the "site" on either server.

[tngTUDOR]

It's getting tricky to find out the exact format required to build the URLs so that readthedocs respects them.

[michaelweinold]

It's getting tricky to find out the exact format required to build the URLs so that readthedocs respects them.

Best to open this in a new issue:

• Cross-References and Links in the Documentation are different between local and readthedocs builds #104

I might need to add some documentation on how to use relative paths to link to other pages.

@cmutel where is this supposed to point to anyway ? I don't see the "site" on either server

Resolved as per my email to the both of you.

[tngTUDOR]

@aringot , with the closing of #104 , the documentation website is fully functional again.
Thank you for reporting the broken docs.