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

[Docs] Automate docs generation and exclude HTML from main branch #4056

Open
2 tasks
DanielYang59 opened this issue Sep 9, 2024 · 0 comments
Open
2 tasks

[Docs] Automate docs generation and exclude HTML from main branch #4056

DanielYang59 opened this issue Sep 9, 2024 · 0 comments
Labels
best practice Discussion/changes of best practices ci Continuous integration docs Documentation, examples, user guides

Comments

@DanielYang59
Copy link
Contributor

DanielYang59 commented Sep 9, 2024 •
edited
Loading

Post from #4053 (comment):

  • Add docs builder as an automatic workflow, I think we already have one jekyll-gh-pages.yml but it doesn't seem to be used
  • Exclude generated HTMLs from main branch, we would need a dedicated branch just to host docs

UPDATE 30 Oct: I'm working on this, to avoid overlapping.

It's a bit hard for me to work on this as I don't have access, help from maintainer would be appreciated.
@DanielYang59 DanielYang59 changed the title [Dev/Docs] [Dev/Docs] Automate docs generation and exclude HTML from VCS Sep 9, 2024
@janosh janosh added docs Documentation, examples, user guides ci Continuous integration best practice Discussion/changes of best practices labels Sep 9, 2024
@DanielYang59 DanielYang59 mentioned this issue Oct 30, 2024
Open
@DanielYang59 DanielYang59 changed the title [Dev/Docs] Automate docs generation and exclude HTML from VCS [Docs] Automate docs generation and exclude HTML from main branch Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
best practice Discussion/changes of best practices ci Continuous integration docs Documentation, examples, user guides
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@janosh @DanielYang59