Start writing docs

mkdocstrings · Apr 16, 2024 · 88aa01b · 88aa01b
1 parent 206ef97
commit 88aa01b
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ which we parse using [regex](https://regular-expressions.info).
 
 ## Examples
 
-See the [`examples`](examples) folder.
+See the [`examples`](https://github.com/mkdocstrings/vba/tree/master/examples) folder.
 
 To build an example site:
 
@@ -32,6 +32,7 @@ python -m unittest
 ```
 
 This will run all tests. This includes
+
 - Unit tests from `tests/`.
 - Doctests from `mkdocstrings_vba/`.
 - Full builds from `examples/`.

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+site/
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -0,0 +1,27 @@
+site_name: "mkdocstrings-vba"
+site_description: "A VBA handler for mkdocstrings."
+site_url: "https://mkdocstrings.github.io/vba"
+repo_url: "https://github.com/mkdocstrings/vba"
+repo_name: "mkdocstrings/vba"
+docs_dir: "src"
+watch:
+  - ../README.md
+  - mkdocs.yml
+  - src
+copyright: Copyright &copy; 2022 Rudolf Byker
+edit_uri: edit/master/docs/
+
+nav:
+  - Home: index.md
+  - mkdocstrings: https://mkdocstrings.github.io/
+
+theme:
+  name: material
+  features:
+    - content.action.edit
+    - content.action.view
+
+markdown_extensions: 
+  - pymdownx.snippets:
+      check_paths: True
+      restrict_base_path: False
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+mkdocs==1.*
+pymdown-extensions==10.*
+mkdocs-material==9.*
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1 @@
+--8<-- "../README.md"