Major Website Update

[fsenf]

This is a follow-up of #470 - an imitative to update our website.

Let's try to document further development here, i.e.

• what needs top be done
• and who is working on and implementing updates
  as long this is in a draft stage.

Here #473 , we documented minimum requirements for a homepage release. I repeat it to have everything at one place:

• meaningful images without duplication
• content-rich landing pages for each entry point from page menu
• correct API section
• check passed that no content from earlier implementation is lost

[fsenf]

I discussed with @Sven-248 today that he might look into the "Section Navigation" thing.

[github-actions]

Linting results by Pylint:

Your code has been rated at 8.72/10 (previous run: 8.72/10, +0.00)
_{The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the RC_v1.6.0 branch.
A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.27%. Comparing base (0ebee82) to head (9f7537b).

Additional details and impacted files

@@            Coverage Diff             @@
##           RC_v1.6.0     #477   +/-   ##
==========================================
  Coverage      62.27%   62.27%           
==========================================
  Files             23       23           
  Lines           3690     3690           
==========================================
  Hits            2298     2298           
  Misses          1392     1392           

Flag	Coverage Δ
unittests	62.27% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[freemansw1]

Thanks, @fsenf . I've been working on debugging the API page and have it most of the way there. I'll push those changes when it's working.

[freemansw1]

I've updated the API pages to work properly now. I've removed some of the documentation pages, especially from anything internal.

One question I have for the group is whether or not to start hiding functions from the API documentation. Take tobac.feature_detection.feature_position as an example. It should only be called internally, I cannot think of a reason for it to be called externally. We can remove it (or any other function) from the docs by adding :meta private: to the docstring. I think that would be a good idea for us to do.

[fsenf]

@freemansw1 : Great update! API reference looks nice now!

I agree to hide everything that is not primarily used externally. This keeps the API docs clear.

[fsenf]

I added our example thumbnails to the entry point of our homepage. There is room for improvement ... What does the group think?

see: https://tobac--477.org.readthedocs.build/en/477/

[freemansw1]

I added our example thumbnails to the entry point of our homepage. There is room for improvement ... What does the group think?

see: https://tobac--477.org.readthedocs.build/en/477/

Thanks, @fsenf . That is a significant improvement. I think, broadly, we should find a way to have the homepage take up more of the page, and have less whitespace. Perhaps that means switching homepage templates, perhaps that just means expanding the content some. Right now, I'm working on figuring out hiding private API functions (:meta private: did not work by itself).