diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..26d3d1f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +mkdocs: + configuration: mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..51418a6 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,5 @@ +# Nextcloud Spreed Signaling Server Documentation + +## API + +* [Standalone signaling API](standalone-signaling-api-v1.md) diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..19bab73 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,22 @@ +site_name: Nextcloud Spreed Signaling API documentation + +theme: + name: readthedocs + highlightjs: true + hljs_languages: + - bash + - golang + - json + - make + - markdown + +markdown_extensions: + - admonition + - def_list + - toc: + permalink: "#" + baselevel: 2 + +nav: + - 'API documentation': + - 'Standalone signaling API': 'standalone-signaling-api-v1.md'