Skip to content

[WIP] add a docs test CI workflow #4391

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
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WIP] add a docs test CI workflow #4391

wants to merge 2 commits into from

Conversation

zingale
Copy link
Member

@zingale zingale commented Mar 31, 2023

this checks the Sphinx build and whether the links are resolvable

PR Summary

PR Checklist

  • New features are documented, with docstrings and narrative docs
  • Adds a test for any bugs fixed. Adds tests for new features.

zingale added 2 commits March 31, 2023 11:14
@zingale
add a docs test CI workflow
428137d 
this checks the Sphinx build and whether the links are
resolvable
@zingale
black formatting
79202f2
@munkm munkm added docs infrastructure Related to CI, versioning, websites, organizational issues, etc labels Jul 20, 2023
neutrinoceros
neutrinoceros reviewed Jul 21, 2023
View reviewed changes
.github/workflows/docs-test.yml
on:
push:
branches:
- development
Copy link
Member

Choose a reason for hiding this comment

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

we don't have a branch by this name

.github/workflows/docs-test.yml
- main
pull_request:
branches:
- development
Copy link
Member

Choose a reason for hiding this comment

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

same as above

.github/workflows/docs-test.yml
${{ runner.os }}-pip-

- name: Install dependencies
run: pip install -r ./requirements.txt
Copy link
Member

Choose a reason for hiding this comment

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

this file doesn't exist

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@neutrinoceros neutrinoceros neutrinoceros left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
docs infrastructure Related to CI, versioning, websites, organizational issues, etc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@zingale @neutrinoceros @munkm