Skip to content

Implement Documentation Generation with pydoctor #45

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.

Sign up for GitHub

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

Jump to bottom
Merged
threeal merged 4 commits into from
Oct 30, 2023
Merged

Implement Documentation Generation with pydoctor #45

threeal merged 4 commits into from
Oct 30, 2023

Conversation

@threeal
Copy link
Owner

@threeal threeal commented Oct 30, 2023 •
edited
Loading

This pull request introduces pydoctor for generating API documentations of Python modules. It also includes the following changes:

  • Add docstring to all modules and functions.
  • Add a step in the test job for generating API documentations.
  • Add an entry in the key feature section of the README.md.

It closes #43, #44.

@threeal threeal self-assigned this Oct 30, 2023
@threeal threeal added the docs label Oct 30, 2023
@threeal threeal added this to the Python Starter v1.1.0 milestone Oct 30, 2023
@threeal threeal force-pushed the pydoctor-docs-generation branch from 5be45ce to 0e3fc43 Compare October 30, 2023 08:42
@threeal threeal marked this pull request as ready for review October 30, 2023 08:55
@threeal threeal merged commit a25c151 into main Oct 30, 2023
@threeal threeal deleted the pydoctor-docs-generation branch October 30, 2023 08:56
@threeal threeal linked an issue Oct 30, 2023 that may be closed by this pull request
Implement Documentation Generation with pydoctor #44
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@threeal threeal

Labels

docs

Projects

No open projects
Python Projects
Status: Done

Milestone

Version 1.1.0

Development

Successfully merging this pull request may close these issues.

Implement Documentation Generation with pydoctor Enable Documentation Generation with pydoc

2 participants

@threeal