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

feature: add pydoctor to generate automatic documentation #321

Closed

Conversation

AlberTajuelo
Copy link
Contributor

Added the following:

  • pydoctor to create automatic documentation
  • removed currencies list and added a link to currencies docs.
  • improved CONTRIBUTING.md file
  • removed duplicated license in README.md file

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:

  • Remove inside the README file all functions and examples and place inside code.
  • Add more documentation to each module/class/function.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant