Skip to content

Commit

Permalink
Show inherited members in the Python SDK documentation (#221)
Browse files Browse the repository at this point in the history
sphinx/autoapi does not show inherited members by default. This PR adds
a setting for it with some `Taskfile` update
  • Loading branch information
termoshtt authored Dec 17, 2024
1 parent 542bf32 commit 3407f0d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
29 changes: 29 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,29 @@ tasks:
build_book:
cmds:
- jupyter-book build doc

build_book_all:
cmds:
- jupyter-book build doc --all

open_book:
cmds:
- python -m webbrowser file:///$(pwd)/doc/_build/html/index.html

book:
cmds:
- task: build_book
- task: open_book

book_all:
cmds:
- task: build_book_all
- task: open_book

watch_build_book:
cmds:
- fswatch -o doc/**/*.ipynb | xargs -n1 -I{} jupyter-book build doc

doc_rust:
cmds:
- cargo doc --no-deps -p ommx
Expand Down Expand Up @@ -92,6 +113,14 @@ tasks:
- sphinx-build -b html source build
dir: python/ommx-python-mip-adapter/docs

open_doc_python_sdk:
cmds:
- python -m webbrowser file:///$(pwd)/python/ommx/docs/build/index.html

open_doc_python_mip_adapter:
cmds:
- python -m webbrowser file:///$(pwd)/python/ommx-python-mip-adapter/docs/build/index.html

stubgen:
cmds:
- cargo run --bin stub_gen --features=stub_gen
Expand Down
1 change: 1 addition & 0 deletions python/ommx/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
autoapi_dirs = ["../../ommx"]
autoapi_options = [
"members",
"inherited-members",
"undoc-members",
"show-module-summary",
]
Expand Down

0 comments on commit 3407f0d

Please sign in to comment.