-
Notifications
You must be signed in to change notification settings - Fork 56
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
Move CI from travis-ci to Github Actions #868
Conversation
Not ready for review or merge, yet. Take a look, though, it is working! Much faster completion time that travis now. |
source $CONDA/bin/activate $ENV_NAME | ||
make makebuilddir | ||
pushd build/manual | ||
# CI needs latexmk to execute next line |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found on WSL2 with Ubunutu 20.04.1 that I needed these packages to build the PDFs
python3-lxml
python-is-python3
python3-pip
xsltproc
texlive-latex-extra
latexmk
xindy
then used
$ pip3 install --user sphinx
And added ~/.local/bin
to PATH
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to try and keep the setup to using pip rather than the ubuntu-specific packages. This would make transition to other build OS more consistent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But, some things, such as texlive-latex-extra
and latexmk
are unavoidable. What is xindy
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think one of the style files used by sphinx required it for index processing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's keep that in mind when/if we change the CI instructions to use the OS-provided toolset and not conda. Since the docs build in full with no errors now using the conda toolset, it's not necessary to use the OS-provided python toolset.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to build the PDF documentation during these syntax checks? We're not publishing from this workflow. Can we leave out this step until we decide to publish the docs from this workflow (related to #663)?
All existing test steps pass now. Ready for review. |
Note (thanks to @danielballan):
|
Example python project that runs GH Actions without using conda: https://github.com/bluesky/ophyd/tree/master/.github/workflows |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
fixes #867