Skip to content

Commit 0323415

Browse files
committed
feat: added mkdocs infra
1 parent ddfbb7b commit 0323415

File tree

9 files changed

+613
-2
lines changed

9 files changed

+613
-2
lines changed

doc/NOTES.md renamed to docs/NOTES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Open questions
22

3+
Open questions to be discussed regarding the design of the new igraph
4+
Python interface:
5+
36
- Shall we allow string representations of enums to be resolved to their
47
corresponding enum values? This would make it possible to write something
58
like `"directed"` instead of `Adjacency.DIRECTED`.

docs/index.md

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

mkdocs.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
site_name: igraph ctypes interface for Python
2+
repo_url: https://github.com/igraph/python-igraph-ctypes
3+
# repo_name: igraph/python-igraph-ctypes
4+
5+
theme:
6+
name: material
7+
8+
features:
9+
- content.action.edit
10+
- navigation.instant
11+
- navigation.tracking
12+
- navigation.footer
13+
14+
palette:
15+
# Palette toggle for light mode
16+
- media: "(prefers-color-scheme: light)"
17+
scheme: default
18+
primary: red
19+
toggle:
20+
icon: material/brightness-7
21+
name: Switch to dark mode
22+
23+
# Palette toggle for dark mode
24+
- media: "(prefers-color-scheme: dark)"
25+
scheme: slate
26+
primary: red
27+
toggle:
28+
icon: material/brightness-4
29+
name: Switch to light mode
30+
31+
extra:
32+
consent:
33+
title: Cookie consent
34+
description: >-
35+
We use cookies to recognize your repeated visits and preferences, as well
36+
as to measure the effectiveness of our documentation and whether users
37+
find what they're searching for. With your consent, you're helping us to
38+
make our documentation better.
39+
40+
social:
41+
- icon: fontawesome/brands/twitter
42+
link: https://twitter.com/igraph2
43+
- icon: fontawesome/brands/mastodon
44+
link: https://fosstodon.org/@igraph
45+
46+
copyright: >
47+
Copyright © 2003 - 2023 The igraph core team –
48+
<a href="#__consent">Change cookie settings</a>

poetry.lock

Lines changed: 557 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ richbench = "^1.0.3"
1717
igraph = "^0.10.6"
1818
stimulus = { git = "https://github.com/igraph/stimulus.git", tag = "0.14.1" }
1919

20+
[tool.poetry.group.doc.dependencies]
21+
mkdocs-material = "^9.1.21"
22+
2023
[tool.poetry-dynamic-versioning]
2124
enable = true
2225

src/codegen/run.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ def main():
274274
"-t",
275275
str(SOURCE_FOLDER / "codegen" / "types.yaml"),
276276
"-D",
277-
str(SOURCE_FOLDER.parent / "doc" / "fragments"),
277+
str(SOURCE_FOLDER.parent / "docs" / "fragments"),
278278
]
279279

280280
args = [

0 commit comments

Comments
 (0)