QSD-Group / QSDsan

Quantitative Sustainable Design (QSD) of sanitation and resource recovery systems.
https://qsdsan.com
Other
30 stars 12 forks source link

Documentation rework #81

Closed yalinli2 closed 2 years ago

yalinli2 commented 2 years ago

Hey @joyxyz1994, I reworked the documentation structure, check out the new look in the beta doc!

The main change is that the index (i.e., home) page and the navigation bar are much cleaner, I think it makes it easier for people to know what's there quickly. But I recall you do like detailed navigation bar, I hope you like the dropdown 😊

PS, the sphinx-design package is incredible

Screen Shot 2022-08-20 at 8 29 22 PM Screen Shot 2022-08-20 at 8 30 09 PM
codecov[bot] commented 2 years ago

Codecov Report

Merging #81 (4ea290b) into main (c2d3788) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #81   +/-   ##
=======================================
  Coverage   75.53%   75.53%           
=======================================
  Files          82       82           
  Lines       13769    13769           
  Branches     1581     1581           
=======================================
  Hits        10401    10401           
  Misses       2949     2949           
  Partials      419      419           
Flag Coverage Δ
unittests 75.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
qsdsan/processes/_adm1.py 78.16% <ø> (ø)
qsdsan/sanunits/_non_reactive.py 92.85% <ø> (ø)
qsdsan/sanunits/_toilets.py 82.36% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

joyxyz1994 commented 2 years ago

Looking great! I'm digging this new template 👍🏼 💯

yalinli2 commented 2 years ago

Sounds great, merging it in now!