Удалите слово «модуль» из документации Sphinx - PullRequest
Новая
       6

Удалите слово «модуль» из документации Sphinx

0 голосов
/ 16 мая 2018

Использование Sphinx для документирования моего проекта на Python.Я хочу удалить слово "module" , которое следует за именем каждого файла python (в панели навигации, оглавлении, заголовке страницы и т. Д.).

например, Подробности:

Проект состоит из 2 файлов utils.py и main.py.

В моем файле index.rst я использую: 

.. toctree::
   :maxdepth: 2

   utils
   main

для импортаоба файла как «модули».Затем из папки docs/ я вызываю: 

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

для создания статического сайта.На сайте слово «модуль» следует за каждым именем файла, и я хотел бы удалить его.

Ответы [ 2 ]

0 голосов
/ 16 августа 2019

Sphinx 3 добавляет шаблоны для файлов reST, сгенерированных sphinx-apidoc.

. Используйте параметр --templatedir, чтобы указать путь к директории, содержащей файлы module.rst_t, package.rst_t и toc.rst_t.Файлы могут быть созданы из соответствующих файлов в site-packages/sphinx/templates/apidoc.

Затем в package.rst_t заменить 

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

на 

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

Повторить для module.rst_t.

0 голосов
/ 23 мая 2018

Одно из возможных решений использует JS, чтобы найти и заменить слово «модуль» после загрузки страницы:

Создать файл source/_templates/layout.html со следующим содержанием: 

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

Убедитесь, что для conf.py установлено templates_path = ['_templates'], тогда Sphinx добавит скрипт к <head> всех страниц документации и вуаля!

...