Skip to content

Commit 1b79700

Browse files
authored
Build/add myst parser (#1)
* build(markdown): setup myst_parser and fix engine build * feat(conf): add project name
1 parent 88801a5 commit 1b79700

File tree

4 files changed

+17
-6
lines changed

4 files changed

+17
-6
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
uses: actions/checkout@v4
3434
- name: setup sphinx
3535
run: |
36-
pip install sphinx sphinx_rtd_theme myst_parser
36+
pip install -r requirements.txt
3737
- name: build docs
3838
run: |
3939
./build.sh

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
gh-pages
2+
Doxyfile

conf.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
# from cgitb import html
2-
3-
# extensions = ["breathe"]
1+
extensions = ["breathe", "myst-parser"]
42

53
html_theme = "sphinx_rtd_theme"
64

75
# Breathe configuration
8-
# breathe_projects = {"ecs-lib": "doc_out/xml"}
9-
# breathe_default_project = "ecs-lib"
6+
breathe_projects = {"ecs-lib": "engine/docs/registry/api/xml"}
7+
breathe_default_project = "ecs-lib"
8+
9+
source_suffix = {
10+
".rst": "restructuredtext",
11+
".txt": "markdown",
12+
".md": "markdown",
13+
}
14+
15+
project = "Nanoforge"

requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
sphinx
2+
sphinx_rtd_theme
3+
myst_parser
4+
breathe

0 commit comments

Comments
 (0)