Skip to content

GH action to build and deploy docs #66

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

Closed
wants to merge 2 commits into from
Closed

GH action to build and deploy docs #66

wants to merge 2 commits into from

Conversation

cadenmyers13
Copy link
Contributor

closes #56

Most of this code is from docs.yml in diffpy.utils

@sbillinge
Copy link
Contributor

@cadenmyers13 this is failing flake8 in pre-commit. You can see what the failure is by clicking on "Details". You will have to fix those two issues identified manually and then try again. If you merge a synced main into this branch then you will get the pre-commit working on your local and you can check this passes before pushing to the PR.

You can also see why the build docs is failing by clicking on details in that workflow. We are missing a build.txt with the requirements needed for building the docs.

@@ -37,6 +41,7 @@ jobs:
run: make -C doc/manual html

- name: Deploy
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
Copy link
Collaborator

Choose a reason for hiding this comment

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

if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'release' }}

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.

Documents and build
3 participants