Skip to content Skip to sidebar Skip to footer
Home / Python / Python Sphinx

Shorter References In A Sphinx Documentation For A Single-package Project

Post a Comment
I am writing a Sphinx documentation for a Python project with a single top-level package my_package. To reference modules/classes in this package, I currently use :mod:`my_package.

Solution 1:

Include 

.. currentmodule:: my_package

at the top of your rst files, then you can leave this out in references.

Post a Comment for "Shorter References In A Sphinx Documentation For A Single-package Project"