diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index ff45953..b04f1a4 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -36,3 +36,11 @@ jobs: #Run unit tests coverage run -m unittest discover . --pattern '*test.py' coverage report + - name: Github Pages + uses: JamesIves/github-pages-deploy-action@3.7.1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages + CLEAN: true + run: + pip install mkdocs-material && mkdocs gh-deploy --force diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..29c16e6 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,8 @@ +[![Build Status](https://img.shields.io/travis/ringcentral/ringcentral-python/master.svg)](https://travis-ci.org/ringcentral/ringcentral-python) +[![Coverage Status](https://coveralls.io/repos/github/ringcentral/ringcentral-python/badge.svg?branch=master)](https://coveralls.io/github/ringcentral/ringcentral-python?branch=master) +[![Twitter](https://img.shields.io/twitter/follow/ringcentraldevs.svg?style=social&label=follow)](https://twitter.com/RingCentralDevs) + +__[RingCentral Developers](https://developer.ringcentral.com/api-products)__ is a cloud communications platform which can be accessed via more than 70 APIs. The platform's main capabilities include technologies that enable: +__[Voice](https://developer.ringcentral.com/api-products/voice), [SMS/MMS](https://developer.ringcentral.com/api-products/sms), [Fax](https://developer.ringcentral.com/api-products/fax), [Glip Team Messaging](https://developer.ringcentral.com/api-products/team-messaging), [Data and Configurations](https://developer.ringcentral.com/api-products/configuration)__. + +[API Reference](https://developer.ringcentral.com/api-docs/latest/index.html) and [APIs Explorer](https://developer.ringcentral.com/api-explorer/latest/index.html). \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..cbadc5e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,40 @@ +site_name: RingCentral Python SDK +theme: + name: material + features: + - navigation.path + - navigation.tabs + - navigation.top + - navigation.expand + - navigation.sections + - search.sharing + - search.highlight + - content.code.copy + - content.action.edit + - content.action.view + - content.code.annotate + palette: + - scheme: default + primary: custom + accent: indigo + toggle: + icon: material/toggle-switch + name: Switch to dark mode + - scheme: slate + primary: black + accent: indigo + toggle: + icon: material/toggle-switch-off-outline + name: Switch to light mode + font: + text: Roboto + code: Roboto Mono + + plugins: + - search: + separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' + - badges + - exclude: + regex: + - '^\.#.*' + - '.*\.\#.*$' \ No newline at end of file