How do Numpy and Scipy use sphinx to process the title of a module?

36 Views Asked by At

I am writing a sphinx document like Numpy and Scipy.

The title comments of a module is shown below:

"""
==============================
Material (:mod:`xxx.material`)
==============================
"""

which is as the title of Scipy's module fft. The corresponding html is fft

I get the following on the generated HTML.

xxx.material
Material (xxx.material)

Generating the title xxx.material before Material (xxx.material) is natrual. I checked the Numpy's autosummary template. Its fiest line is,

{% extends "!autosummary/module.rst" %}

and the first line in the file autosummary/module.rst is

{{ fullname | escape | underline}}

However, Numpy and Scipy do not have the above xxx.material. How do they achieve it? I really want to remove the extra title as well.

Could someone familiar with the sphinx docmentation of Numpy or Scipy help me? Thanks!

0

There are 0 best solutions below