Add code documentation generated from docstrings

[happz]

Adding a new section into "Contribute" page, "Code documentation", and besides the actual code documenation, I propose moving "Classes" page there as well.

[psss]

Seems that sh does not know pushd:

pushd ../ && sphinx-apidoc --force --implicit-namespaces --no-toc -o docs/autodocs tmt && popd
/bin/sh: 1: pushd: not found
make: *** [Makefile:37: autodocs] Error 127
running '/bin/bash -c 'make autodocs''

See the whole build log for details.

[happz]

Yeah, I already checked logs, realized I don't have enough time to resolve this, and pushed it out to the next release.

[psss]

I'm seeing a bunch of warnings during make docs:

/home/psss/git/tmt/tmt/frameworks/beakerlib.py:docstring of tmt.frameworks.beakerlib.Beakerlib.extract_results:1: WARNING: more than one target found for cross-reference 'Test': tmt.base.Test, tmt.Test
/home/psss/git/tmt/tmt/frameworks/beakerlib.py:docstring of tmt.frameworks.beakerlib.Beakerlib.extract_results:1: WARNING: more than one target found for cross-reference 'Guest': tmt.Guest, tmt.steps.provision.Guest
/home/psss/git/tmt/tmt/frameworks/beakerlib.py:docstring of tmt.frameworks.beakerlib.Beakerlib.get_environment_variables:1: WARNING: more than one target found for cross-reference 'Test': tmt.base.Test, tmt.Test
...

I guess we should remove the Essential Classes section where the duplication happens?

[happz]

I'm seeing a bunch of warnings during make docs:

/home/psss/git/tmt/tmt/frameworks/beakerlib.py:docstring of tmt.frameworks.beakerlib.Beakerlib.extract_results:1: WARNING: more than one target found for cross-reference 'Test': tmt.base.Test, tmt.Test
/home/psss/git/tmt/tmt/frameworks/beakerlib.py:docstring of tmt.frameworks.beakerlib.Beakerlib.extract_results:1: WARNING: more than one target found for cross-reference 'Guest': tmt.Guest, tmt.steps.provision.Guest
/home/psss/git/tmt/tmt/frameworks/beakerlib.py:docstring of tmt.frameworks.beakerlib.Beakerlib.get_environment_variables:1: WARNING: more than one target found for cross-reference 'Test': tmt.base.Test, tmt.Test
...

I guess we should remove the Essential Classes section where the duplication happens?

I believe this is caused by from tmt.base import Test in tmt/__init__.py. That act introduces tmt.Test name, and when Sphinx comes across Test type annotation, it's not clear whether it's tmt.Test or tmt.base.Test.

I tried to address a couple of these, but more work is needed.

[psss]

Thanks for enabling this, looks very nice! Would be nice to get rid of the warnings. Otherwise just two minor issues.

[psss]

I believe this is caused by from tmt.base import Test in tmt/__init__.py. That act introduces tmt.Test name, and when Sphinx comes across Test type annotation, it's not clear whether it's tmt.Test or tmt.base.Test.

Seems that ignore-module-all fixes that, see my comment above.