Исключить комментарии из Sphinx literalinclude - PullRequest
Новая
       12

Исключить комментарии из Sphinx literalinclude

2 голосов
/ 10 мая 2019

Я пытался документировать свою основную программу, используя sphinx.Я не мог понять, как использовать функции autodoc для использования функций literalinclude, включая start-after и end-before.Кто-нибудь знает, как это сделать с помощью autodoc?Я смог использовать его только для документирования класса или модуля класса.

Main.py [будет документировано] 

#Label_BasicLibraries_Start
IGNORE: 
This libraries are imported basic libraries.
IGNORE:
import time
import json
import urllib.parse
import random

from functools import reduce
import os.path
#Label_BasicLibraries_End

Это код, который яИспользую на данный момент: 

Title Example
=======================================================
This is beautiful code.

.. literalinclude:: Main.py
  :language: python
  :start-after: #Label_BasicLibraries_Start
  :end-before: #Label_BasicLibraries_End
  :linenos:

Я могу отфильтровать всю программу, используя обе альтернативы.Есть ли способ исключить определенные линии, начинающиеся с фиксированного маркера или между другими маркерами?Как в этом примере для строк документации?

Большое спасибо за помощь!

...