Remove the word "module" from Sphinx documentation

Question

Using Sphinx for documenting my Python project. I want to remove the word "module" which follows the name of each python file (in the navbar, TOC, the page title, etc).

e.g. Details:

The project is composed of 2 files utils.py and main.py.

In my index.rst file, I use:

.. toctree:: :maxdepth: 2 utils main

to import both files as "modules". From the docs/ folder, I then call:

sphinx-apidoc -f -o ./source/ .. make html

to generate the static site. In the site, the word "module" follows every file name, and I would like to remove it.

After sphinx-apidoc -f -o ./source/ .., what is in your utils.rst and main.rst? I think part of the problem is that sphinx-apidoc is designed for packages, not modules: "sphinx-apidoc is a tool for automatic generation of Sphinx sources that, using the autodoc extension, document a whole package in the style of other automatic API documentation tools." — Steve Piercy
– Steve Piercy, Commented May 16, 2018 at 4:09

Roger Dahl · Accepted Answer · 2019-08-27 16:58:02Z

16

Sphinx 2.2 adds templating for the reST files generated by sphinx-apidoc.

Use the --templatedir option to set the path to a dir containing module.rst_t, package.rst_t and toc.rst_t files. The files can be created from the corresponding files in site-packages/sphinx/templates/apidoc.

Then, in package.rst_treplace

{{- [submodule, "module"] | join(" ") | e | heading(2) }}

with

{{- submodule | e | heading(2) }}

Repeat for module.rst_t.

edited Aug 27, 2019 at 16:58

answered Aug 16, 2019 at 7:03

Roger Dahl

15.8k8 gold badges72 silver badges88 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

mzjn Over a year ago

According to sphinx-doc.org/en/master/changes.html#id9, the --templatedir option was added already in Sphinx 2.2.0.

Roger Dahl Over a year ago

@mzjn True, but as far as I could tell, that version wasn't released (not available via PyPI / pip).

mzjn Over a year ago

Strange that it does not work for you. I was able to install it via pip. And pypi.org/project/Sphinx says that 2.2.0 is the latest release.

Roger Dahl Over a year ago

Ah -- it was released on Aug 18. I posted this answer on the 16th :)

jessexknight Over a year ago

I can't find the default files in site-packages/sphinx/templates/apidoc on my computer, but you can find them here

|

jessexknight · Accepted Answer · 2018-05-23 18:39:29Z

One possible solution uses JS to find & replace the word "module" after the page loads:

Create a file source/_templates/layout.html with the following content:

{% extends "!layout.html" %} {% block extrahead %} <script type="text/javascript"> window.onload = function() { document.body.innerHTML = document.body.innerHTML.replace(/ module/g, ''); } </script> {% endblock %}

Make sure that conf.py has templates_path = ['_templates'] set, then Sphinx will append the script to the <head> of all documentation pages, and voila!

Collectives™ on Stack Overflow

Remove the word "module" from Sphinx documentation

2 Answers 2

6 Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

6 Comments

Comments

Linked

Related