Fds automatic docs

[adam-narozniak]

Issue

Currently, the documentation process is done manually. It is prone to errors by not adding the created code (that might be documented).

Description

The only role of the currently working scripts is just to transform the .rst files into HTML files. The creation of the .rst files is assumed to be manual.

Proposal

Use the sphinx-autosummary to fully automatize the docs building process.

Explanation

sphinx-autosummary enable automatic recursive creation of the .rst files (by filling it with sphinx-autodoc output). It additionally provides a summary table with a one-sentence summary and a link to the documentation. (see picture below).

This PR introduces:

1. Templates (they dictate how the class and module rst files look like).
2. Modification of the index file to use autosummary.
3. Configuration adjustment that
   a. Excludes the test.py files
   b. Dictates how the files look.
   c. Tells that the docs should only follow the code in __all __

Note: this PR does not introduce storing the .rst files with the documentation (and deletes the previous single file)

Preview

Summary tables

Documentation page: FederatedDataset

Toggle buttons

Shortcommings

• Shows also inheritance from the object class

[charlesbvll]

LGTM!