Skip to content

Commit 71cbf80

Browse files
committed
sphinx being too much of a pain, trying with mkdocs
1 parent 91cba55 commit 71cbf80

File tree

6 files changed

+74
-6
lines changed

6 files changed

+74
-6
lines changed

.readthedocs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ build:
1414
- alsa-base
1515
- alsa-utils
1616

17-
sphinx:
18-
configuration: docs/conf.py
17+
mkdocs:
18+
configuration: mkdocs.yml # Changed from sphinx
1919

2020
python:
2121
install:

docs/api.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,3 @@ API Documentation
88

99
.. toctree::
1010
:maxdepth: 2
11-
12-
# Add any submodules here, for example:
13-
# npcsh.submodule1
14-
# npcsh.submodule2

docs/api/image.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Image Processing
2+
3+
::: npcsh.image
4+
options:
5+
show_source: true
6+
members:
7+
- capture_screenshot
8+
- analyze_image
9+
- analyze_image_base
10+
show_root_heading: false
11+
show_if_no_docstring: true

docs/api/llm_funcs.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# LLM Functions
2+
3+
::: npcsh.llm_funcs
4+
options:
5+
show_source: true
6+
members:
7+
- get_llm_response
8+
- get_stream
9+
show_root_heading: false

docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# npcsh Documentation
2+
3+
```python
4+
from npcsh import Shell
5+
shell = Shell()
6+
shell.run()
7+
```
8+
9+
## Features
10+
- Audio processing
11+
- Image analysis
12+
- LLM integration
13+
14+
[Get Started](#api)

mkdocs.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
site_name: npcsh
2+
site_url: https://npcsh.readthedocs.io/
3+
repo_url: https://github.com/cagostino/npcsh
4+
5+
theme:
6+
name: material
7+
features:
8+
- navigation.tabs
9+
- content.code.copy
10+
- content.tabs.link
11+
12+
markdown_extensions:
13+
- admonition
14+
- pymdownx.superfences
15+
- attr_list
16+
- pymdownx.highlight:
17+
anchor_linenums: true
18+
19+
plugins:
20+
- mkdocstrings:
21+
handlers:
22+
python:
23+
import:
24+
- https://docs.python.org/3/objects.inv
25+
selection:
26+
members:
27+
- public
28+
- !__init__
29+
rendering:
30+
show_source: true
31+
show_root_heading: false
32+
33+
nav:
34+
- Home: index.md
35+
- API:
36+
- Audio: api/audio.md
37+
- Image: api/image.md
38+
- LLM Functions: api/llm_funcs.md

0 commit comments

Comments
 (0)