chore(appium,docutils): proof-of-concept for use with mkdocs
MODIFY
packages/appium/docs/base-mkdocs.yml
packages/appium/docs/base-mkdocs.yml
@@ -2,7 +2,7 @@ INHERIT: ../../docutils/base-mkdocs.yml
site_name: Appium Documentation
repo_url: https://github.com/appium/appium
repo_name: appium/appium
-copyright: Copyright &copy; 2012 - 2022 OpenJS Foundation
+copyright: Copyright &copy; 2012 OpenJS Foundation
theme:
logo: assets/images/appium-logo-white.png

ADD
packages/appium/docs/en/reference.md
+{!appium_base_driver.md!}

MODIFY
packages/appium/docs/mkdocs-en.yml
packages/appium/docs/mkdocs-en.yml
@@ -44,6 +44,7 @@ nav:
- guides/event-timing.md
- guides/log-filters.md
- guides/grid.md
+ - Reference: reference.md
- Ecosystem:
- ecosystem/index.md
- Developing Appium Extensions:

ADD
packages/docutils/README.md
+# @appium/docutils
+
+> Documentation-building utilities for Appium
+
+## Prerequisites
+
+- `mkdocs` v1.4.0
+- `mkdocs-material` v8.2.8
+- `mkdocs-material-extensions` v1.0.3
+
+Run `pip install -r requirements.txt` to install MkDocs & its deps.
+
+## Running
+
+This package does not need to be run directly. Instead, execute this command in the `packages/appium` folder of [this monorepo](https://github.com/appium/appium):
+
+```bash
+npm run dev:docs:en
+````
+
+See the `scripts` field of the `package.json` for other languages.

MODIFY
packages/docutils/base-mkdocs.yml
packages/docutils/base-mkdocs.yml
@@ -14,6 +14,8 @@ markdown_extensions:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- footnotes
+ - markdown_include.include:
+ base_path: ../../typedoc-docs/commands
extra:
generator: false

ADD
packages/docutils/requirements.txt
+mkdocs==1.4.0
+mkdocs-material==8.2.8
+mkdocs-material-extensions==1.0.3
+markdown-include==0.8.0

chore(appium,docutils): proof-of-concept for use with mkdocs