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

feat: Replaced epydoc with pydoctor #2425

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

Evolancer02
Copy link

I, @mljoshi, and @Michael-Kowata have worked on replacing the API documentation tool epydoc with pydoctor, addressing the issue #1364.

Changes that were made:

  • Removed the docs/epy folder and the old HTML files inside the folder that were generated with epydoc
  • Created a new folder called pydoc and regenerated the appropriate HTML files with pydoctor inside the folder
  • Updated the associated links in some of the markdown files
  • Updated the command for the generation of the HTML files in the build.sh file

Files that were updated:

  • docs/README.md
  • docs/batch.md
  • docs/build
  • docs/media.md
  • docs/mocks.md
  • docs/start.md

…. Removed the generated files with epydoc. Updated build.sh. Updated some of the markdown files
@Evolancer02 Evolancer02 requested a review from a team as a code owner July 1, 2024 04:05
@product-auto-label product-auto-label bot added the size: xl Pull request size is extra large. label Jul 1, 2024
@Evolancer02 Evolancer02 changed the title Replaced epydoc with pydoctor #1364 Replaced epydoc with pydoctor Jul 1, 2024
@Evolancer02 Evolancer02 changed the title Replaced epydoc with pydoctor Replaced epydoc with pydoctor 1364 Jul 1, 2024
@Evolancer02 Evolancer02 changed the title Replaced epydoc with pydoctor 1364 Replaced epydoc with pydoctor Jul 1, 2024
@Evolancer02 Evolancer02 changed the title Replaced epydoc with pydoctor Replaced epydoc with pydoctor (feat) Jul 1, 2024
@Evolancer02 Evolancer02 changed the title Replaced epydoc with pydoctor (feat) Replaced epydoc with pydoctor Jul 1, 2024
@Evolancer02 Evolancer02 changed the title Replaced epydoc with pydoctor feat: Replaced epydoc with pydoctor Jul 1, 2024
docs/build Outdated Show resolved Hide resolved
@mljoshi
Copy link

mljoshi commented Aug 5, 2024

Also fixes #2300.

@utsab
Copy link

utsab commented Oct 30, 2024

@tristanlatr or @vchudnov-g -- Is it possible for you to take a look at this PR sometime this week? The authors of this PR are students at the Computing Talent Initiative (CTI), and they are presenting their work this Friday. It would be nice if this PR were to get approved by then or at least give them some feedback which they can talk about during their presentation. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: xl Pull request size is extra large.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants