Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make documentation easier to access #218

Closed
matthewfcarlson opened this issue Oct 22, 2019 · 8 comments · Fixed by #248
Closed

Make documentation easier to access #218

matthewfcarlson opened this issue Oct 22, 2019 · 8 comments · Fixed by #248
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@matthewfcarlson
Copy link
Contributor

The documentation should be accessible by web.

@matthewfcarlson
Copy link
Contributor Author

This is in progress

@Javagedes Javagedes self-assigned this Nov 3, 2022
@Javagedes
Copy link
Contributor

Javagedes commented Nov 3, 2022

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?

@Javagedes
Copy link
Contributor

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

@spbrogan
Copy link
Member

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.

@Javagedes
Copy link
Contributor

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

@Javagedes
Copy link
Contributor

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.

@Javagedes
Copy link
Contributor

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

@Javagedes
Copy link
Contributor

Javagedes commented Dec 15, 2022

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.

@Javagedes Javagedes transferred this issue from tianocore/edk2-pytool-extensions Dec 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants