apidoc improvements

[AntonioCarta]

• Made some minor changes to docstrings to fix errors
• added a small function that checks for classes missing from the apidoc
• added a readme in docs for documentation for developers building the docs.

This was quite painful.

TODO: there are many classes that are not in the apidoc but should be. Let's try to add them before the next release.

@AndreaCossu can you do this check for the evaluation modules? also some of the descriptions may need to be updated.

@lrzpellegrini can you do it for the detection stuff?

read the doc for info on how to compile the doc without seeing tons of errors. Please try to not commit file with syntax errors.

[ContinualAI-bot]

Oh no! It seems there are some PEP8 errors! 😕
Don't worry, you can fix them! 💪
Here's a report about the errors and where you can find them:

avalanche/benchmarks/datasets/endless_cl_sim/endless_cl_sim.py:274:81: E501 line too long (90 > 80 characters)
avalanche/benchmarks/datasets/endless_cl_sim/endless_cl_sim.py:277:81: E501 line too long (92 > 80 characters)
avalanche/training/supervised/strategy_wrappers.py:198:16: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:198:18: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:261:16: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:261:18: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:342:16: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:342:18: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:459:16: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:459:18: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:526:16: W605 invalid escape sequence '\*'
avalanche/training/supervised/strategy_wrappers.py:526:18: W605 invalid escape sequence '\*'
2       E501 line too long (90 > 80 characters)
10      W605 invalid escape sequence '\*'

[AntonioCarta]

@ggraffieti how can we silence pycodestyle on W605 warnings?

avalanche/training/supervised/strategy_wrappers.py:526:18: W605 invalid escape sequence '\*'

This is not an error, we need to escape * because it's a special character in the ReST markup.

[ggraffieti]

You can edit the setup.cfg file in the main project directory and add warning W605 into the list of the ignored errors/warnings 👍

[coveralls]

Pull Request Test Coverage Report for Build 2330539875

• 9 of 29 (31.03%) changed or added relevant lines in 9 files are covered.
• 5 unchanged lines in 3 files lost coverage.
• Overall coverage decreased (-0.03%) to 70.541%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
avalanche/benchmarks/classic/clear.py	0	4	0.0%
avalanche/benchmarks/scenarios/exmodel_scenario.py	0	6	0.0%
avalanche/benchmarks/datasets/clear/clear.py	3	13	23.08%

Files with Coverage Reduction	New Missed Lines	%
avalanche/benchmarks/scenarios/exmodel_scenario.py	1	38.89%
avalanche/benchmarks/datasets/inaturalist/inaturalist.py	2	25.0%
avalanche/benchmarks/scenarios/classification_scenario.py	2	89.86%

Totals
Change from base Build 2296389316:	-0.03%
Covered Lines:	12035
Relevant Lines:	17061

---

💛 - Coveralls