feature: add pydoctor to generate automatic documentation #321
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added the following:
You will need to configure your GitHub page at Settings > Pages (https://github.com/bukson/steampy/settings/pages):
Select "Build and deployment" > "Source", the "Deploy from a branch" value.
In "Branch" select "gh-pages", select "/ (root)" and press the "Save" button.
Now, it will run the GitHub page workflow in the "gh-pages" branch and when it finishes, you just need to go to: https://bukson.github.io/steampy/
If you follow the previous steps, you can see how it looks on my GitHub page (https://albertajuelo.github.io/steampy/index.html).
Future steps to improve the documentation in this project: