Skip to content

Commit 83d1588

Browse files
watermarkhuwatermarkhu
authored
feat: All options working (#4)
* add general docs * add back parameter_headings option * improve headings section * bump mkdocstrings-python * done with headings section * fix inherited members, member order * better docs * fix docstring parameter handling * fixes * first attempt at hiding hidden and private members * working hidden and private members * finalize hidden and private members * first attempt summaries * summaries almost working * comments * updates * merge constructor * docs * hide previews * docstrings section done * finalize signatures * update logo * first attempt at workflows * finalize workflow
1 parent d520c2b commit 83d1588

67 files changed

Lines changed: 3775 additions & 596 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @watermarkhu

‎.github/workflwos/release.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
10+
publish:
11+
runs-on: ubuntu-latest
12+
environment: release
13+
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
ref: ${{ github.sha }}
20+
21+
- name: Python semantic release
22+
id: release
23+
uses: python-semantic-release/python-semantic-release@v9.15.1
24+
with:
25+
build: false
26+
changelog: true
27+
commit: true
28+
push: true
29+
tag: true
30+
github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
31+
32+
- name: Install the latest version of uv
33+
if: steps.release.outputs.released == 'true'
34+
uses: astral-sh/setup-uv@v5
35+
with:
36+
version: "latest"
37+
38+
- name: Publish package to PyPI with UV
39+
if: steps.release.outputs.released == 'true'
40+
run: |
41+
uv sync --no-dev --group docs
42+
uv build
43+
uv publish
44+
45+
- name: Publish package distributions to GitHub Releases
46+
uses: python-semantic-release/upload-to-gh-release@v9.15.1
47+
if: steps.release.outputs.released == 'true'
48+
with:
49+
github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
50+
tag: ${{ steps.release.outputs.tag }}
51+
52+
# - name: Build documentation with mike
53+
# if: steps.release.outputs.released == 'true'
54+
# run: >
55+
# uv run mike deploy
56+
# --branch gh-pages
57+
# --alias-type copy
58+
# --update-aliases
59+
# --push
60+
# ${{ steps.release.outputs.tag }} latest
61+
62+
# uv run mike set-default --branch gh-pages --push latest

‎.python-version‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.12
1+
3.13

‎.vscode/launch.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
"jinja": true
1515
},
1616
{
17-
"name": "Python Debugger: mkdocstrings test",
17+
"name": "Python Debugger: mkdocstrings debug docs",
1818
"type": "debugpy",
1919
"request": "launch",
20-
"program": "test/debug.py",
20+
"program": "docs/debug.py",
2121
"console": "integratedTerminal",
2222
"justMyCode": false,
23-
"jinja": true
23+
"jinja": true,
2424
}
2525
]
26-
}
26+
}

‎.vscode/settings.json‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
{
2-
"python.analysis.typeCheckingMode": "standard"
3-
}
2+
"material-icon-theme.languages.associations": {
3+
"jinja-html": "html"
4+
},
5+
"files.associations": {
6+
"*.html": "jinja-html"
7+
},
8+
"emmet.includeLanguages": {
9+
"jinja-html": "html"
10+
},
11+
}

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# CHANGELOG
2+
3+
4+
## v0.0.0 (2025-01-02)

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
---
77

8-
<p align="center"><img src="logo.png"></p>
8+
<p align="center"><img src="logo.svg"></p>
99

1010
The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. Via the python bindings the Abstract Syntax Tree (AST) of the source code is traversed to extract useful information. The imported objected are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/).
1111

test/debug.py renamed to docs/debug.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,16 @@ def set_directory(path: Path):
1515
os.chdir(origin)
1616

1717

18-
config_path = Path(__file__).parent.resolve() / "mkdocs.yml"
18+
config_path = Path(__file__).parent.parent.resolve() / "mkdocs.yml"
1919

2020
kwargs = {
2121
"dev_addr": None,
2222
"open_in_browser": False,
23-
"livereload": True,
23+
"livereload": False,
2424
"build_type": None,
2525
"watch_theme": True,
2626
"config_file": str(config_path),
2727
"strict": None,
28-
"theme": None,
2928
"use_directory_urls": None,
3029
}
3130

‎docs/logo.svg‎

Lines changed: 57 additions & 0 deletions
Loading

‎docs/snippets/+module/+submodule/Contents.m‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
% This is a submodule

0 commit comments

Comments
 (0)