setup github action to build and deploy mkdocs

Author: josephlim94

.github/workflows/README.md

@@ -0,0 +1,71 @@
+# GitHub Actions Workflows
+
+## Documentation Deployment
+
+The `docs.yml` workflow automatically builds and deploys the project documentation to GitHub Pages.
+
+### Workflow Details
+
+- **Trigger**: Runs on pushes to `master` branch, pull requests to master, and manual dispatch
+- **Build**: Uses Poetry to install dependencies and MkDocs to build the documentation
+- **Deploy**: Automatically deploys to GitHub Pages on pushes to master branch
+
+### Setup Requirements
+
+1. **GitHub Pages**: Enable GitHub Pages in your repository settings
+   - Go to Settings → Pages
+   - Set Source to "GitHub Actions"
+
+2. **Dependencies**: The workflow uses:
+   - Python 3.11
+   - Poetry for dependency management
+   - MkDocs Material theme
+   - GitHub Actions for deployment
+
+### Workflow Steps
+
+1. **Build Job**:
+   - Checkout repository
+   - Set up Python and Poetry
+   - Cache dependencies for faster builds
+   - Install development dependencies
+   - Build documentation with MkDocs
+   - Upload build artifacts
+
+2. **Deploy Job** (only on master):
+   - Deploy artifacts to GitHub Pages
+   - Set up custom domain if configured
+
+### Local Testing
+
+To test the documentation build locally:
+
+```bash
+# Install dependencies
+poetry install --only=dev
+
+# Build documentation
+poetry run mkdocs build --clean --strict
+
+# Serve locally for development
+poetry run mkdocs serve
+```
+
+### Configuration
+
+The documentation is configured in:
+- `mkdocs.yml` - MkDocs configuration
+- `docs/` - Documentation source files
+- `site/` - Generated documentation (auto-generated, don't commit)
+
+### Site URL
+
+The documentation will be available at:
+`https://josephlim94.github.io/python_janus_client/`
+
+### Branch Configuration
+
+This workflow is configured to work with the `master` branch only:
+- Builds on pushes to master
+- Builds on pull requests targeting master
+- Deploys only from master branch

.github/workflows/docs.yml

@@ -0,0 +1,75 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: latest
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --only=dev
+
+      - name: Build documentation
+        run: |
+          poetry run mkdocs build --clean --strict
+
+      - name: Setup Pages
+        if: github.ref == 'refs/heads/master'
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        if: github.ref == 'refs/heads/master'
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./site
+
+  deploy:
+    if: github.ref == 'refs/heads/master'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: Python Janus Client
 site_description: Easily send and share WebRTC media through Janus WebRTC server.
-site_url: https://janus-client-in-python.readthedocs.io/
+site_url: https://josephlim94.github.io/python_janus_client/
 repo_url: https://github.com/josephlim94/python_janus_client
 repo_name: josephlim94/python_janus_client
 

site/404.html

@@ -13,7 +13,7 @@
 
 
 
-      <link rel="icon" href="/assets/python_janus_client_icon.svg">
+      <link rel="icon" href="/python_janus_client/assets/python_janus_client_icon.svg">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.20">
 
 
@@ -22,10 +22,10 @@
 
 
 
-      <link rel="stylesheet" href="/assets/stylesheets/main.e53b48f4.min.css">
+      <link rel="stylesheet" href="/python_janus_client/assets/stylesheets/main.e53b48f4.min.css">
 
 
-        <link rel="stylesheet" href="/assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="/python_janus_client/assets/stylesheets/palette.06af60db.min.css">
 
 
 
@@ -44,7 +44,7 @@
 
 
 
-    <script>__md_scope=new URL("/",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("/python_janus_client/",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
 
 
@@ -83,9 +83,9 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="/." title="Python Janus Client" class="md-header__button md-logo" aria-label="Python Janus Client" data-md-component="logo">
+    <a href="/python_janus_client/." title="Python Janus Client" class="md-header__button md-logo" aria-label="Python Janus Client" data-md-component="logo">
 
-  <img src="/assets/python_janus_client_icon.svg" alt="logo">
+  <img src="/python_janus_client/assets/python_janus_client_icon.svg" alt="logo">
 
     </a>
     <label class="md-header__button md-icon" for="__drawer">
@@ -230,7 +230,7 @@
 
 
     <li class="md-tabs__item">
-      <a href="/." class="md-tabs__link">
+      <a href="/python_janus_client/." class="md-tabs__link">
 
 
 
@@ -249,7 +249,7 @@
 
 
     <li class="md-tabs__item">
-      <a href="/session/" class="md-tabs__link">
+      <a href="/python_janus_client/session/" class="md-tabs__link">
 
 
 
@@ -268,7 +268,7 @@
 
 
     <li class="md-tabs__item">
-      <a href="/plugins/" class="md-tabs__link">
+      <a href="/python_janus_client/plugins/" class="md-tabs__link">
 
 
 
@@ -287,7 +287,7 @@
 
 
     <li class="md-tabs__item">
-      <a href="/transport/" class="md-tabs__link">
+      <a href="/python_janus_client/transport/" class="md-tabs__link">
 
 
 
@@ -322,9 +322,9 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="/." title="Python Janus Client" class="md-nav__button md-logo" aria-label="Python Janus Client" data-md-component="logo">
+    <a href="/python_janus_client/." title="Python Janus Client" class="md-nav__button md-logo" aria-label="Python Janus Client" data-md-component="logo">
 
-  <img src="/assets/python_janus_client_icon.svg" alt="logo">
+  <img src="/python_janus_client/assets/python_janus_client_icon.svg" alt="logo">
 
     </a>
     Python Janus Client
@@ -351,7 +351,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/." class="md-nav__link">
+      <a href="/python_janus_client/." class="md-nav__link">
 
 
 
@@ -373,7 +373,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/session/" class="md-nav__link">
+      <a href="/python_janus_client/session/" class="md-nav__link">
 
 
 
@@ -395,7 +395,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/plugins/" class="md-nav__link">
+      <a href="/python_janus_client/plugins/" class="md-nav__link">
 
 
 
@@ -417,7 +417,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/transport/" class="md-nav__link">
+      <a href="/python_janus_client/transport/" class="md-nav__link">
 
 
 
@@ -525,10 +525,10 @@ <h1>404 - Not found</h1>
 
 
 
-      <script id="__config" type="application/json">{"base": "/", "features": ["content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tooltips", "navigation.footer", "navigation.indexes", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "/assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
+      <script id="__config" type="application/json">{"base": "/python_janus_client/", "features": ["content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tooltips", "navigation.footer", "navigation.indexes", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "/python_janus_client/assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
 
 
-      <script src="/assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="/python_janus_client/assets/javascripts/bundle.f55a23d4.min.js"></script>
 
 
   </body>

site/index.html

@@ -10,7 +10,7 @@
 
 
 
-        <link rel="canonical" href="https://janus-client-in-python.readthedocs.io/">
+        <link rel="canonical" href="https://josephlim94.github.io/python_janus_client/">
 
 
 

site/plugins/index.html

@@ -10,7 +10,7 @@
 
 
 
-        <link rel="canonical" href="https://janus-client-in-python.readthedocs.io/plugins/">
+        <link rel="canonical" href="https://josephlim94.github.io/python_janus_client/plugins/">
 
 
         <link rel="prev" href="../session/">

site/search/search_index.json

@@ -10,7 +10,7 @@
 
 
 
-        <link rel="canonical" href="https://janus-client-in-python.readthedocs.io/session/">
+        <link rel="canonical" href="https://josephlim94.github.io/python_janus_client/session/">
 
 
         <link rel="prev" href="..">
@@ -811,28 +811,30 @@ <h5 id="detach_pluginplugin"><code>detach_plugin(plugin)</code><a class="headerl
 <p><strong>Returns:</strong>
 - <code>Dict[str, Any]</code>: Response from Janus server confirming detachment</p>
 <h2 id="usage-example">Usage Example<a class="headerlink" href="#usage-example" title="Permanent link">&para;</a></h2>
-<p>```python
-import asyncio
-from janus_client import JanusSession, JanusEchoTestPlugin</p>
-<p>async def main():
-    # Create session
-    session = JanusSession(base_url="wss://example.com/janus")</p>
-<div class="language-text highlight"><pre><span></span><code>try:
-    # Use session as async context manager for automatic cleanup
-    async with session:
-        # Create and attach plugin
-        plugin = JanusEchoTestPlugin()
-        await plugin.attach(session)
-
-        # Use plugin...
-
-        # Plugin will be automatically destroyed when session closes
-
-except Exception as e:
-    print(f&quot;Error: {e}&quot;)
-</code></pre></div>
-<p>if <strong>name</strong> == "<strong>main</strong>":
-    asyncio.run(main())</p>
+<div class="language-python highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="kn">import</span> <span class="nn">asyncio</span>
+</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="kn">from</span> <span class="nn">janus_client</span> <span class="kn">import</span> <span class="n">JanusSession</span><span class="p">,</span> <span class="n">JanusEchoTestPlugin</span>
+</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
+</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="k">async</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
+</span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>    <span class="c1"># Create session</span>
+</span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a>    <span class="n">session</span> <span class="o">=</span> <span class="n">JanusSession</span><span class="p">(</span><span class="n">base_url</span><span class="o">=</span><span class="s2">&quot;wss://example.com/janus&quot;</span><span class="p">)</span>
+</span><span id="__span-6-7"><a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a>
+</span><span id="__span-6-8"><a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a>    <span class="k">try</span><span class="p">:</span>
+</span><span id="__span-6-9"><a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a>        <span class="c1"># Use session as async context manager for automatic cleanup</span>
+</span><span id="__span-6-10"><a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a>        <span class="k">async</span> <span class="k">with</span> <span class="n">session</span><span class="p">:</span>
+</span><span id="__span-6-11"><a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a>            <span class="c1"># Create and attach plugin</span>
+</span><span id="__span-6-12"><a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a>            <span class="n">plugin</span> <span class="o">=</span> <span class="n">JanusEchoTestPlugin</span><span class="p">()</span>
+</span><span id="__span-6-13"><a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a>            <span class="k">await</span> <span class="n">plugin</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="n">session</span><span class="p">)</span>
+</span><span id="__span-6-14"><a id="__codelineno-6-14" name="__codelineno-6-14" href="#__codelineno-6-14"></a>
+</span><span id="__span-6-15"><a id="__codelineno-6-15" name="__codelineno-6-15" href="#__codelineno-6-15"></a>            <span class="c1"># Use plugin...</span>
+</span><span id="__span-6-16"><a id="__codelineno-6-16" name="__codelineno-6-16" href="#__codelineno-6-16"></a>
+</span><span id="__span-6-17"><a id="__codelineno-6-17" name="__codelineno-6-17" href="#__codelineno-6-17"></a>            <span class="c1"># Plugin will be automatically destroyed when session closes</span>
+</span><span id="__span-6-18"><a id="__codelineno-6-18" name="__codelineno-6-18" href="#__codelineno-6-18"></a>
+</span><span id="__span-6-19"><a id="__codelineno-6-19" name="__codelineno-6-19" href="#__codelineno-6-19"></a>    <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+</span><span id="__span-6-20"><a id="__codelineno-6-20" name="__codelineno-6-20" href="#__codelineno-6-20"></a>        <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+</span><span id="__span-6-21"><a id="__codelineno-6-21" name="__codelineno-6-21" href="#__codelineno-6-21"></a>
+</span><span id="__span-6-22"><a id="__codelineno-6-22" name="__codelineno-6-22" href="#__codelineno-6-22"></a><span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
+</span><span id="__span-6-23"><a id="__codelineno-6-23" name="__codelineno-6-23" href="#__codelineno-6-23"></a>    <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">())</span>
+</span></code></pre></div>