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

Documentation is not updated since 2021 #443

Closed
sh-cho opened this issue Oct 31, 2023 · 0 comments · Fixed by #444
Closed

Documentation is not updated since 2021 #443

sh-cho opened this issue Oct 31, 2023 · 0 comments · Fixed by #444

Comments

@sh-cho
Copy link
Contributor

sh-cho commented Oct 31, 2023

Hello, I'm trying to use promgen and looked around documentation a bit, and noticed something is off.

What's wrong?

Looks like current documentation is published in Mar 30, 2021 and it is not updated since then.

image

And in sphinx.yml, it checks github reference if it is same with refs/heads/main, which should be actually refs/heads/master.

So Deploy to GitHub Pages step is always skipped, so that documentation is not published.

How to fix

image

Checking if github ref is master is an easy fix, but it's not enough.

gh-pages branch is not necessary, because in github, it is possible to directly deploy 'pages' with github actions (⚠️ if only changed repository settings)

In this case, generated files are attached as "Artifacts" in actions, and it is possible to deploy Artifacts with actions/deploy-pages, so no need to use third-party action (e.g. JamesIves/github-pages-deploy-action)

I will make PR shortly, but if you have another opinion, please let me know!

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 a pull request may close this issue.

1 participant