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.

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

[Feat][Doc] switch to poetry project for docs generating #384

Merged
merged 11 commits into from
Feb 28, 2024
Merged

[Feat][Doc] switch to poetry project for docs generating #384

merged 11 commits into from
Feb 28, 2024

Conversation

SemyonSinchenko
Copy link
Member

@SemyonSinchenko SemyonSinchenko commented Feb 27, 2024 •
edited
Loading

Proposed changes

As discussed in #382

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Close #382

@SemyonSinchenko
Switch to poetry
82e3ec7 
 On branch 382-poetry-docs
 Changes to be committed:
	modified:   .github/workflows/docs.yml
@SemyonSinchenko SemyonSinchenko self-assigned this Feb 27, 2024
@SemyonSinchenko SemyonSinchenko added the Component:Documentation Improvements or additions to documentation label Feb 27, 2024
@SemyonSinchenko
Add missing deps
8aba92d 
 On branch 382-poetry-docs
 Changes to be committed:
	modified:   .github/workflows/docs.yml
@SemyonSinchenko
Fix Makefile
be54cfb 
 On branch 382-poetry-docs
 Changes to be committed:
	modified:   docs/Makefile
@SemyonSinchenko
CI update
12468b9 
 On branch 382-poetry-docs
 Changes to be committed:
	modified:   docs/Makefile
@SemyonSinchenko
Fix typo
b8a8fd0 
 On branch 382-poetry-docs
 Changes to be committed:
	modified:   docs/Makefile
@SemyonSinchenko
Fix docs
4967274 
 On branch 382-poetry-docs
 Changes to be committed:
	modified:   docs/Makefile
@SemyonSinchenko
Try to fix
5c44786
@SemyonSinchenko
Try to fix CI
d6510c2
@SemyonSinchenko SemyonSinchenko marked this pull request as ready for review February 27, 2024 23:20
acezen
acezen reviewed Feb 28, 2024
View reviewed changes
docs/Makefile Outdated Show resolved Hide resolved
acezen
acezen reviewed Feb 28, 2024
View reviewed changes
Copy link
Contributor

@acezen acezen left a comment

Choose a reason for hiding this comment

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

as we use poetry to generate docs, the requirements.txt file seems not use any more. Better to remove it if it's unused.

@SemyonSinchenko
Update from comments
f8e2ca9 
 On branch 382-poetry-docs
 Changes to be committed:
	modified:   .github/workflows/docs.yml
	modified:   docs/Makefile
	deleted:    docs/requirements.txt
@SemyonSinchenko
Merge remote-tracking branch 'upstream/main' into 382-poetry-docs
401b873
acezen
acezen reviewed Feb 28, 2024
View reviewed changes
docs/Makefile Outdated Show resolved Hide resolved
@acezen
Copy link
Contributor

acezen commented Feb 28, 2024

Hi, Sem, Can you update the document generation part in https://github.com/alibaba/GraphAr/blob/main/CONTRIBUTING.rst#how-to-generate-the-document
to the latest generation process, including install dependencies through poetry.

acezen
acezen reviewed Feb 28, 2024
View reviewed changes
docs/Makefile Show resolved Hide resolved
@SemyonSinchenko
Updates from comments
401e08c 
 On branch 382-poetry-docs
 Changes to be committed:
	modified:   CONTRIBUTING.rst
	modified:   docs/Makefile
@SemyonSinchenko
Copy link
Member Author

Hi, Sem, Can you update the document generation part in https://github.com/alibaba/GraphAr/blob/main/CONTRIBUTING.rst#how-to-generate-the-document to the latest generation process, including install dependencies through poetry.

Did it.

acezen
acezen approved these changes Feb 28, 2024
View reviewed changes
Copy link
Contributor

@acezen acezen left a comment

Choose a reason for hiding this comment

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

LGTM

@acezen acezen merged commit fc91672 into apache:main Feb 28, 2024
2 checks passed
@SemyonSinchenko SemyonSinchenko deleted the 382-poetry-docs branch April 22, 2024 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@acezen acezen acezen approved these changes

Assignees

@SemyonSinchenko SemyonSinchenko

Labels
Component:Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feat][Doc] using poetry for managing all the python dependencies
2 participants
@SemyonSinchenko @acezen