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

Automated documentation generation from docstrings and typings #19

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

phemmylintry
Copy link
Contributor

closes #18

@phemmylintry phemmylintry requested a review from a team February 2, 2024 13:43
Copy link
Contributor

@parisk parisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@phemmylintry let's ignore all files in docs/build and remove them from Git history, because it's quite difficult to review the current PR.

docs/build/doctrees/environment.pickle Outdated Show resolved Hide resolved
docs/build/doctrees/index.doctree Outdated Show resolved Hide resolved
@phemmylintry phemmylintry requested a review from parisk February 2, 2024 15:27
Copy link
Contributor

@parisk parisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Let's just ditch the Windows batch file and we should be good to go.

docs/make.bat Outdated Show resolved Hide resolved
@phemmylintry phemmylintry requested a review from parisk February 2, 2024 16:08
Copy link
Contributor

@parisk parisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last change @phemmylintry! Please squash all commits, so we avoid bringing the removed docs/build files into main.

Remove unused files and directories

docs

Fix formatting

Add make.bat to .gitignore
Copy link
Contributor

@parisk parisk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🦘

@phemmylintry phemmylintry merged commit 7fdccf2 into main Feb 8, 2024
1 check passed
@phemmylintry phemmylintry deleted the docs branch February 8, 2024 14:15
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.

Automated documentation generation from docstrings and typings
2 participants