Skip to content

Commit 8d5be00

Browse files
koczkatamaskoczkatamas
committed
docs: add Markdown support
1 parent d6c8b06 commit 8d5be00

26 files changed

Lines changed: 64 additions & 393 deletions

‎.github/workflows/deploy-docs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ jobs:
4242
pip install -U exhale
4343
pip install -U sphinx-rtd-theme
4444
pip install -U sphinxcontrib-mermaid
45+
pip install -U myst-parser
4546
4647
- name: Generating API XML with Doxygen
4748
working-directory: ./docs

‎docs/introduction.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,14 @@ These areas are moon-shot plans to explore in the future in case kernelXDK deeme
7979
* Syzkaller-integration: generate exploits automatically from crashes.
8080

8181
* Windows, macOS support.
82+
83+
# Components
84+
85+
```{toctree}
86+
:maxdepth: 1
87+
88+
libxdk
89+
kxdb_database
90+
kernel_image_tools
91+
gadget_tools
92+
```

‎docs/src/about/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../introduction.md

‎docs/src/about/index.rst‎

Lines changed: 0 additions & 97 deletions
This file was deleted.

‎docs/src/about/kxdb.rst‎

Lines changed: 0 additions & 72 deletions
This file was deleted.

‎docs/src/about/kxdb_database.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../kxdb_database.md

‎docs/src/about/libxdk.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../libxdk/README.md

‎docs/src/about/libxdk.rst‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎docs/src/commandline_tools/image_db.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../image_db/README.md

‎docs/src/commandline_tools/image_runner.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../image_runner/README.md

0 commit comments

Comments
 (0)