Skip to content

Build dev docs action#235

Merged
BenjaminDev merged 13 commits intoOpenMined:devfrom
BenjaminDev:build-dev-docs-action
Aug 12, 2020
Merged

Build dev docs action#235
BenjaminDev merged 13 commits intoOpenMined:devfrom
BenjaminDev:build-dev-docs-action

Conversation

@BenjaminDev
Copy link
Copy Markdown
Member

Description

This PR addresses #107
Added a github action that builds the 'bleeding edge' python-dp package based on latest code in the dev branch and publishes the docs to github-pages.

The official release (PyPI package) docs are still on readthedocs.

Affected Dependencies

List any dependencies that are required for this change.

How has this been tested?

  • Ran the action on my fork and it works as expected

Todo:

This pr will has a workflow that will run on pushes to dev which will put the built docs in the gh-pages branch. To serve these an Openmined developer must go to settings and activate github pages as shown below.

image

Checklist

branch: gh-pages
directory: gh-pages
force: true
github_token: ${{ secrets.GITHUB_TOKEN }}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Which token needs to be added here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

That gets picked up by default. No need to configure it.

@BenjaminDev BenjaminDev merged commit 832f60f into OpenMined:dev Aug 12, 2020
dvadym added a commit to dvadym/PyDP that referenced this pull request Jul 3, 2022
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.

2 participants