Skip to content

Add sphinx-matlab-apidoc #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jasonnicholson wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add sphinx-matlab-apidoc #334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad31845
feat: adding sphinx-matlab-apidoc
jasonnicholson Jan 3, 2026
48d6855
Merge branch 'master-origin' into add-sphinx-matlab-apidoc
jasonnicholson Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ skip = "./.git"
[tool.coverage.run]
branch = true
omit = [
'*/_build/*'
'*/_build/*',
'sphinxcontrib\__init__.py'
Copy link
Copy Markdown
Collaborator

@Remi-Gau Remi-Gau Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this needed? I may be missing something.

Copy link
Copy Markdown
Contributor Author

@jasonnicholson jasonnicholson Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can update your pytest config so that it produces coverage for the things you want. I moved the pytest config to pyproject.toml below. If you want HTML coverage for the current active python version and installed Sphinx, you call pytest --cov-report=html. The HTML coverage will get generated. Ignoring the init.py is what allows you get coverage for the whole folder sphinxcontrib sanely.

[tool.pytest.ini_options]
addopts = "-ra --strict-config --strict-markers --show-capture=all --showlocals -s -vv --cov=sphinxcontrib --cov=tests --cov-report=term"
doctest_optionflags = "NORMALIZE_WHITESPACE ELLIPSIS"
junit_family = "xunit2"
log_cli_level = "INFO"
xfail_strict = true

[tool.coverage.run]
branch = true
omit = [
    '*/_build/*',
    'sphinxcontrib/__init__.py',
]

]

[tool.pytest.ini_options]
Expand Down
Loading
Loading