SolarArbiter / solarforecastarbiter-core

Core data gathering, validation, processing, and reporting package for the Solar Forecast Arbiter
https://solarforecastarbiter-core.readthedocs.io
MIT License
33 stars 21 forks source link

Wrap report sections in details #737

Closed lboeman closed 2 years ago

lboeman commented 2 years ago

Puts many parts of reports into expandable sections to improve readability. Screenshot of full report is attached for review. Will need to ensure pdfs render correctly. Screenshot 2021-10-06 at 17-14-23 2020 NREL MIDC Humboldt State University GHI

wholmgren commented 2 years ago

The pdf reports do compile and they look fine.

Some of the pdf_* files appear to be exactly the same as the original versions:

Can we put the <details>/<summary> and closing tags in the body.html file instead? e.g.

{% block dataresampleandalign %}
<details id="preprocessing-procedure" open="">
  <summary>
    <h4>Preprocessing procedure</h4>
  </summary>
{% include "data_resampling_preamble" %}
</details>
{% endblock %}

Not a big deal and not sure if it was created by this PR, but there's inconsistent capitalization in pdf tables:

Screen Shot 2021-10-07 at 9 25 45 AM
lboeman commented 2 years ago

Some of the pdf_* files appear to be exactly the same as the original versions:

* pdf_data_resampling_postamble

* pdf_version_description

* maybe more

While I think that having two sets of text files is harder to maintain, I feel like using some prefixed and some non-prefixed text blocks in the pdf template is also an easy way to introduce bugs to the pdf in the future. Happy to remove the duplicates if you don't agree, but that was my thought process here.

lboeman commented 2 years ago

Can we put the <details>/<summary> and closing tags in the body.html file instead?

Moved these, and had to separate out the nested "Data validation procedure" text from data_validation_pre_text

Not a big deal and not sure if it was created by this PR, but there's inconsistent capitalization in pdf tables:

This should be fixed now. Added lower calls to the pdf macros.