create documentation using mkdocs

Author: josephlim94

.readthedocs.yaml

@@ -5,17 +5,17 @@
 # Required
 version: 2
 
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-   configuration: docs/conf.py
+# Build documentation with MkDocs
+mkdocs:
+  configuration: mkdocs.yml
 
 # Optionally build your docs in additional formats such as PDF
 formats: all
 
 build:
   os: "ubuntu-22.04"
   tools:
-    python: "3.7"
+    python: "3.11"
   jobs:
     post_create_environment:
       # Install poetry
@@ -24,6 +24,12 @@ build:
       # Tell poetry to not use a virtual environment
       - poetry config virtualenvs.create false
     post_install:
-      # Install dependencies with 'docs' dependency group
+      # Install dependencies with 'dev' dependency group
       # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
       - poetry install --with dev
+
+# Python configuration
+python:
+  install:
+    - method: pip
+      path: .

README.md

@@ -161,6 +161,46 @@ Server ping:
 
 https://janus-client-in-python.readthedocs.io/
 
+### Documentation Development
+
+This project uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) for documentation.
+
+#### Setup
+
+Install development dependencies:
+
+```bash
+poetry install --with dev
+```
+
+#### Local Development
+
+To serve the documentation locally with live reload:
+
+```bash
+poetry run mkdocs serve
+```
+
+The documentation will be available at http://127.0.0.1:8000/
+
+#### Building Documentation
+
+To build the documentation for production:
+
+```bash
+poetry run mkdocs build
+```
+
+The built documentation will be in the `site/` directory.
+
+#### Documentation Structure
+
+- `docs/index.md` - Main documentation page
+- `docs/session.md` - Session API documentation
+- `docs/plugins.md` - Plugin API documentation
+- `docs/transport.md` - Transport API documentation
+- `mkdocs.yml` - MkDocs configuration file
+
 ## Experiments
 
 FFmpeg support for VideoRoom plugin has now been moved to `experiments` folder, together with GStreamer support.

docs/assets/python_janus_client_icon.svg

@@ -0,0 +1,117 @@
+# Python Janus Client
+
+Easily send and share WebRTC media through [Janus](https://github.com/meetecho/janus-gateway) WebRTC server.
+
+## Key Features
+
+- Supports HTTP/s and WebSockets communication with Janus.
+- Support Admin/Monitor API:
+   - Generic requests
+   - Configuration related requests
+   - Token related requests
+- Supports Janus plugin:
+   - EchoTest Plugin
+   - VideoCall Plugin
+   - VideoRoom Plugin
+- Extendable Transport class and Plugin class
+
+## Library Installation
+
+```bash
+pip install janus-client
+```
+
+## Getting Started
+
+### Simple Connect And Disconnect
+
+```python
+import asyncio
+from janus_client import JanusSession, JanusEchoTestPlugin, JanusVideoRoomPlugin
+
+# Protocol will be derived from base_url
+base_url = "wss://janusmy.josephgetmyip.com/janusbasews/janus"
+# OR
+base_url = "https://janusmy.josephgetmyip.com/janusbase/janus"
+
+session = JanusSession(base_url=base_url)
+
+plugin_handle = JanusEchoTestPlugin()
+
+# Attach to Janus session
+await plugin_handle.attach(session=session)
+
+# Destroy plugin handle
+await plugin_handle.destroy()
+```
+
+This will create a plugin handle and then destroy it.
+
+Notice that we don't need to call connect or disconnect explicitly. It's managed internally.
+
+### Make Video Calls
+
+```python
+import asyncio
+from janus_client import JanusSession, JanusVideoCallPlugin
+from aiortc.contrib.media import MediaPlayer, MediaRecorder
+
+async def main():
+   # Create session
+   session = JanusSession(
+      base_url="wss://janusmy.josephgetmyip.com/janusbasews/janus",
+   )
+
+   # Create plugin
+   plugin_handle = JanusVideoCallPlugin()
+
+   # Attach to Janus session
+   await plugin_handle.attach(session=session)
+
+   # Prepare username and media stream
+   username = "testusernamein"
+   username_out = "testusernameout"
+
+   player = MediaPlayer(
+      "desktop",
+      format="gdigrab",
+      options={
+            "video_size": "640x480",
+            "framerate": "30",
+            "offset_x": "20",
+            "offset_y": "30",
+      },
+   )
+   recorder = MediaRecorder("./videocall_record_out.mp4")
+
+   # Register myself as testusernameout
+   result = await plugin_handle.register(username=username_out)
+
+   # Call testusernamein
+   result = await plugin_handle.call(
+      username=username, player=player, recorder=recorder
+   )
+
+   # Wait awhile then hangup
+   await asyncio.sleep(30)
+
+   result = await plugin_handle.hangup()
+
+   # Destroy plugin
+   await plugin_handle.destroy()
+
+   # Destroy session
+   await session.destroy()
+
+
+if __name__ == "__main__":
+   try:
+      asyncio.run(main())
+   except KeyboardInterrupt:
+      pass
+```
+
+This example will register to the VideoCall plugin using username `testusernameout`. It will then call the user registered using the username `testusernamein`.
+
+A portion of the screen will be captured and sent in the call media stream.
+The incoming media stream will be saved into `videocall_record_out.mp4` file.