Make documentation easier to access about edk2-pytool-library HOT 8 CLOSED

This is in progress

from edk2-pytool-library.

Starting the documentation fix.
Steps:

1. Put all documentation under the google convention and adds a pydocstyle check to the pipeline
2. Add automatic doc generation capability
3. setup release-based documentation generation and hosting - Github.io or Readthedocs?

from edk2-pytool-library.

Step 1 Completed via tianocore/edk2-pytool-extensions#325

from edk2-pytool-library.

Removing from 0.20.0 as we want to make that release and task 2 and 3 are not yet complete (as far as i know). We can catch this in the next release.

from edk2-pytool-library.

Correct. 1 was just finished in both edk2-pytool-library and edk2-pytool-extensions. 2 is almost done.

from edk2-pytool-library.

Number 2 is completed via tianocore/edk2-pytool-extensions#348

I still need to complete Number 2 for edk2-pytool-library, then number 3 will be quick. Planning to upload to readthedocs.

from edk2-pytool-library.

Added check to verify mkdocs builds with no warning or error in tianocore/edk2-pytool-extensions#357

from edk2-pytool-library.

For edk2-pytool-extensions: Documentation generation is working and there is an automatic github action to push updated documentation to github pages on a release.

Moving this task to edk2-pytool-library to continue tracking this issue on that side.

from edk2-pytool-library.