0

I am testing Sphinx to help documenting MatLab (and Python sometimes) code using the comments. After a lot of struggling, I managed to get both working but noticed that I don't get sub-levels on the MatLab rst as I do with the Python rst. Also references to the Matlab classes are just text, unlike with references to Python classes.

Here is my file structure

Project

  • .venv
  • .vscode
  • docs
    • build
      • ...
    • source
      • _static
      • _templates
      • conf.py
      • index.rst
      • Matlab.rst
      • Proof_Of_Concept.rst
    • make
    • Makefile
  • src
    • Proof_of_Concept.py
  • MatLab
    • multiple .m files

index.rst:

.. toctree::
   :maxdepth: 3
   :caption: Contents

   Proof_Of_Concept
   Matlab

Proof_Of_Concept.rst

Python 
================

Some narrative.


Some more narrative.

.. automodule:: Proof_of_Concept

.. autoclass:: Proof_of_Concept
    :members:

For MatLab, see :class:`TRGCore`

MatLab.rst

MatLab Code
============


Some random text.

.. mat:automodule:: TRG
    

:mod:`TRG` is a really cool module.

.. mat:autoclass:: TRGCore
    :members:

Specifically :class:`TRGCore` is dope.
For Python, see :class:`Proof_of_Concept`

The resulting ToC

Does anybody know what I am doing wrong or has pointers for stuff I should check? Thank you in advance!

I expected to have more depth on the ToC under MatLab like TRGCore and that :classTRGCore gives a link to click instead of just bold text.

Improve this question
Related questions
57
Automatically Generating Documentation for All Python Package Contents
2
How to Link Local Python Help Documents Using Sphinx
11
Make classes appear on TOC in Sphinx
Load 4 more related questions Show fewer related questions

0

Reset to default

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.