Skip to content

Commit

Permalink
Fix CUTLASS Python documentation build (codeplaysoftware#91)
Browse files Browse the repository at this point in the history
Modify problematic docstring and instructions to fix build of CUTLASS
Python documentation.

- Docstring: missing newline starting code-block and wrong keyword
- `ipykernel` missing lead to error on Jupyter notebooks
- `docutils>=0.21` drops a member Sphinx is using. Next versions of
  Sphinx will fix this by dropping the usage.

Signed-off-by: Víctor Pérez <[email protected]>
  • Loading branch information
victor-eds authored and aacostadiaz committed Aug 5, 2024
1 parent 130e5b2 commit 59973fb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 4 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,10 @@ Building the documentation requires additional packages. The following commands
```bash
sudo apt-get install pandoc
pip install --upgrade Sphinx furo pandoc myst-parser sphinx-copybutton nbsphinx nbsphinx-link sphinx-inline-tabs
# Needed for jupyter notebooks
pip install ipykernel
# Needed as latest versions are not compatible with Sphinx as of now.
pip install docutils~=0.20.0
```

To build documentation, you must first have installed the CUTLASS Python interface via the
Expand Down
3 changes: 2 additions & 1 deletion python/cutlass/epilogue/epilogue.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,9 @@ def trace(fn, example_tensors, **kwargs):
:param example_tensors: example inputs for fn
:type example_tensors: dict
.. hightlight:: python
.. highlight:: python
.. code-block:: python
import cutlass.backend.evt
# Define epilogue function as Python callable
Expand Down

0 comments on commit 59973fb

Please sign in to comment.