Set up GitHub Pages - Githubissues

alec-kr / F1PyStats

An open-source Python3 package that provides Formula 1 data to developers.

GNU General Public License v3.0

51 stars 19 forks source link

Set up GitHub Pages #120

Closed youpong closed 1 year ago

youpong commented 1 year ago

Description

Build a site like this on GitHub Pages to view the generated API documentation.

alec-kr commented 1 year ago

This is a great idea. I honestly never thought of implementing something like this before.

Should I assign the issue to you? It would be great to see a similar page for this repository in the future 😁

youpong commented 1 year ago

Yes. Please assign to me.

youpong commented 1 year ago

To build GitHub Pages, we need to perform two tasks.

Select Source of GitHub Pages to GitHub Actions.
Create a workflow to deploy.

Requiring administrative privileges, so I ask you to do task 1.

Below is a screenshot of the configuration in my repository. Please refer to it.

alec-kr commented 1 year ago

I have selected GitHub Actions

youpong commented 1 year ago

The workflow consists of two tasks. The building of the document and deploying to GitHub Pages. The deploying was successful. However, there are some problems with the building: the API Docs is not generated correctly.

I will continue to work on it and close this issue when it is resolved.

alec-kr commented 1 year ago

Okay great. Thanks for the update.

Good luck 💪🏽💯