Skip to content

Conversation

@lonnieezell
Copy link
Member

Trying to get docs auto-building on PRs.

First attempt to get auto-building of docs happening
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
Copy link
Member

Choose a reason for hiding this comment

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

Use actions/checkout@v2 now.

@jreklund
Copy link
Contributor

jreklund commented Mar 7, 2020

Looks like a great idea, but with the current user guide we won't get any syntax highlight. As it depending upon cilexer styling. Either we figure out how to include and build it**. Or we update to the latest Sphinx and source/conf.py settings to default into PHP instead. Future proofing the project. As it refers to easy_install that's not being used anymore.

** I tried building it today on my server to check that my latest user guide PR looked good. But it never found ci styling. No idea what went wrong.

@MGatner
Copy link
Member

MGatner commented Mar 7, 2020

@jreklund this is next on my list to look at after #2668. However I have zero Sphinx experience so I’m glad to see you do. I’ll reach out on Slack but feel free to share any resources here too.

@jreklund
Copy link
Contributor

jreklund commented Mar 7, 2020

I have made PR #2671, removing internal package (cilexer) as a requirement.

For this we will need to run pre-build-command: apt install -y python-pip in case it's not already included in that action.

At first glance they use pip (Python 2) and not pip3 (Python 3), so we should be all good there. As the Sphinx version we require only works with Python 2.

@paulbalandan
Copy link
Member

I think this has already been addressed by the userguide_ci.yml workflow?

@lonnieezell
Copy link
Member Author

Oh, wow. Forgot about this one. But, yes, this is already handled. Thanks!

@paulbalandan paulbalandan deleted the docautobuild branch October 24, 2020 17:31
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.

5 participants