Как сгенерировать документацию собственного кода с помощью pydo c? - PullRequest
Новая
       5

Как сгенерировать документацию собственного кода с помощью pydo c?

0 голосов
/ 03 августа 2020

Мне нужно создать документацию с помощью Pydo c. Я уже написал некоторые объяснения, используя строки документации, как в следующем примере 

def function():
    '''
    this function does something
    :return: returns nothing
    '''

Затем я пытаюсь просмотреть свою документацию через Windows PowerShell. Поэтому я использую 

python -m pydoc myfile.py

Но все, что я добиваюсь, это следующая ошибка: 

problem in myFile - IndexError: list index out of range

Моему сценарию нужны дополнительные аргументы, например:

python -m pydoc myfile.py argument1 argument2

Но потом получаю следующие ошибки: 

No Python Documentation found for myfile.
No Python Documentation found for argument1.
No Python Documentation found for argument2.

1 Ответ

0 голосов
/ 03 августа 2020

Проблема не в pydo c, а в написанном вами коде Python; ошибка

problem in myFile - IndexError: list index out of range

означает, что где-то в вашем коде вы пытаетесь получить доступ к элементу списка по индексу. 

mylist = [1, 2, 3]
mylist[0] # should yield "1"
mylist[1] # should yield "2"
mylist[2] # should yield "3"

но индекс вы ' повторное использование недопустимо. 

mylist = [1, 2, 3]
mylist[3] # the index 3 is out of range for this list, so it will give you a IndexError

Убедитесь, что все значения индекса, которые вы используете для доступа к вашему списку, находятся в диапазоне от 0 до длины вашего списка минус один, а затем запустите это в командная строка:

python -m pydoc myfile

...