Skip to content

Add doc builder CI#35

Merged
lewtun merged 12 commits into
mainfrom
add-doc-builder
Mar 28, 2022
Merged

Add doc builder CI#35
lewtun merged 12 commits into
mainfrom
add-doc-builder

Conversation

@lewtun

@lewtun lewtun commented Mar 23, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

This PR adds the doc building steps to the CI so that:

  • The course content is built on every PR
  • The course content is built on every push to the release branch

lewtun
lewtun commented Mar 24, 2022
View reviewed changes
Comment thread .github/workflows/build_documentation.yml
on:
push:
branches:
- release

@lewtun lewtun Mar 24, 2022 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@Pierrci if I set the docs to build on pushes to the release branch like this, will this automatically get updated on hf.co/course or is some extra magic needed on the moon-landing side?

In other words, will this mean we no longer have to ping you to manually deploy the course?

cc @mishig25

@mishig25 mishig25 Mar 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yes, everything is automatic

@mishig25

mishig25 commented Mar 24, 2022

Copy link
Copy Markdown
Contributor

Accidentally approved before asking some questions :) one sec

@mishig25

mishig25 commented Mar 24, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Is there a specific reason why the template was not used? See here an example

uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main

@lewtun

lewtun commented Mar 24, 2022 •
edited
Loading

Copy link
Copy Markdown
Member Author

Is there a specific reason why the template was not used? See here an example

uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main

No strong reason except that my understanding is that the template won't use the --not_python_module argument that we need for the course build. Happy to switch if I'm wrong!

@mishig25

mishig25 commented Mar 25, 2022

Copy link
Copy Markdown
Contributor

No strong reason except that my understanding is that the template won't use the --not_python_module argument that we need for the course build. Happy to switch if I'm wrong!

oh I see, I think it will be the best to modify the template gh workflow to support --not_python_module. I'll work on it & ping you when ready so that you can update this PR 😊

@mishig25 mishig25 mentioned this pull request Mar 25, 2022
Merged
@mishig25

mishig25 commented Mar 25, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

@lewtun huggingface/doc-builder#153 us merged; therefore, please feel free to update this PR with using gh templates

@lewtun

lewtun commented Mar 25, 2022

Copy link
Copy Markdown
Member Author

doc-builder tries to run pip install -e '.[dev]' by default in the templates. Will open a PR to enable support for the --not_python_module arg

@lewtun

lewtun commented Mar 28, 2022

Copy link
Copy Markdown
Member Author

Merging this to unblock https://github.com/huggingface/moon-landing/pull/2276

@lewtun
lewtun merged commit c5f67e7 into main Mar 28, 2022
@lewtun
lewtun deleted the add-doc-builder branch March 28, 2022 07:33
GITbaburin pushed a commit to GITbaburin/course that referenced this pull request May 17, 2026
@lewtun
Merge pull request huggingface#35 from huggingface/add-doc-builder
d9fea35 
Add doc builder CI
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mishig25 mishig25 mishig25 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@lewtun @mishig25