diff --git a/.github/workflows/release-github-pages.yml b/.github/workflows/release-github-pages.yml new file mode 100644 index 0000000..9cdcd67 --- /dev/null +++ b/.github/workflows/release-github-pages.yml @@ -0,0 +1,20 @@ +name: GitHub Pages release +on: + push: + branches: + - master + - main + - tesGitHubPages +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version}} + uses: actions/setup-python@v3 + with: + python-version: ${{ matrix.python-version }} + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/docs/app-registration.md b/docs/app-registration.md new file mode 100644 index 0000000..28c8853 --- /dev/null +++ b/docs/app-registration.md @@ -0,0 +1,4 @@ + +# Registering your application + +Before you begin development, you will first need to register your application via the RingCentral Developer Console. This step will provision your application a unique set of credentials used to identify your application on the network, and comes with the benefits listed below. \ No newline at end of file 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..876333b --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,41 @@ +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 + - social + - exclude: + regex: + - '^\.#.*' + - '.*\.\#.*$' \ No newline at end of file