Docs Setup

[justusschock]

Short Description

Please give a short summary of the main points of this PR

PR Checklist

PR Implementer

This is a small checklist for the implementation details of this PR.
If you submit a PR, please look at these points (don't worry about the RisingTeam
and Reviewer workflows, the only purpose of those is to have a compact view of
the steps)

If there are any questions regarding code style or other conventions check out our
summary.

• Implementation
• Docstrings & Typing
• Check __all__ sections and __init__
• Unittests (look at the line coverage of your tests, the goal is 100%!)
• Update notebooks & documentation if necessary
• Pass all tests
• Add the checksum of the last implementation commit to the Changelog
• Populate docs/source/get_started.rst
• Add tutorials and example for each transform

RisingTeam

RisingTeam workflow

• Add pull request to project (optionally delete corresponding project note)
• Assign correct label (if you don't have permission to do this, someone will do it for you.
  Please make sure to communicate the current status of the pr.)
• Does this PR close an Issue? (add closes #IssueNumber at the bottom if
  not already in description)

Reviewer

Reviewer workflow

• Do all tests pass? (Unittests, NotebookTests, Documentation)
• Does the implementation follow rising design conventions?
• Are the tests useful? (!!!) Are additional tests needed?
  Can you think of critical points which should be covered in an additional test?
• Optional: Check coverage locally / Check tests locally if GPU is necessary to execute

[codecov]

Codecov Report

Merging #61 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #61   +/-   ##
=======================================
  Coverage   97.84%   97.84%           
=======================================
  Files          32       32           
  Lines        1251     1251           
=======================================
  Hits         1224     1224           
  Misses         27       27           

Flag	Coverage Δ
#unittests	97.84% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aec0802...aec0802. Read the comment docs.

[justusschock]

If I build this locally, I get issues with not existing file and not registered source parsers.

@mibaumgartner do you have any experience on this? Otherwise I need to investigate tomorrow.

[mibaumgartner]

No idea (at least without further investigation) 🙈

[justusschock]

Currently I got it working without apidoc (with apidoc it looks weird) and the following needs to be done:

• Add docs for transforms
• Add docs for ops
• Add docs for utils
• add parser for notebooks to integrate tutorials

[justusschock]

With this state we can build docs looking like this:

However, There are still some missing features:

• On my local build the collapse on the right does not work as on pytorch docs (no clue why)
• Integrate notebooks properly
• For each file: Write introductory section, what this file does. (They will be included automatically)
• Write a good getting started and Installation Guide

However: I propose to add these things in a follow-up PR, since that way we can get the current docs already running :) Thoughts @mibaumgartner ?

Edit: See #66 and #67

[mibaumgartner]

Looks good 👍 I think we should start to populate the other features as soon as possible (maybe later today) and use a different PR 👍