Как я могу "импортировать scipy.signal как сигнал" и при этом использовать автодок python sphinx? - PullRequest
Новая
       1

Как я могу "импортировать scipy.signal как сигнал" и при этом использовать автодок python sphinx?

2 голосов
/ 03 января 2011

Я пытаюсь использовать Sphinx для автоматического создания документации для проекта Python.Для одного из модулей требуется пакет scipy.signal, который я пытаюсь импортировать, используя следующее: import scipy.signal в качестве сигнала.Хотя код работает просто отлично, создание html с помощью Sphinx приводит к ошибке сегментации (вывод ниже).Я могу, однако, использовать «import scipy as sp», убедившись, что в моем sys.path есть каталог scipy, и документация генерируется без проблем, но, конечно, в моем коде не будет функциональности, которую янеобходимость.

Я сделал очень простой тестовый пример, чтобы продемонстрировать проблему, создав тестовый класс с несколькими строками документации.Я включаю это ниже вместе со своими.Закомментировав строку «import scipy.signal as signal», все работает довольно хорошо.

Спасибо за любые идеи о том, как избежать сбоя сегмента при одновременном импорте scipy.signal.Lauren

Выход сфинкса: 

sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.0.5
loading pickled environment... done
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
make: *** [html] Segmentation faults

pyexample.py 

import scipy.signal as signal

class TestClass:
    """The TestClass class is used to lalala. I would like this docstring to be     documented by sphinx.
    """

    def __init__(self, A, B):
        self.A = A
        self.B = B

    # Style to use for printing
    def __str__(self):
        str =  "A = " + self.A.__str__() + "\n\n"
        str += "B = " + self.B.__str__() + "\n\n"
        return str

    def __add__(self):
        """Add A+B."""
        total = self.A+self.B
        return total

    def addx(self,x):
        """Add A+x."""
        total = self.A+x
        return total

index.rst 

.. Test documentation master file, created by
   sphinx-quickstart on Sun Jan  2 20:34:04 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Test's documentation!
================================

Contents:

.. toctree::

   docstrings

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

docstrings.rst 

My Modules and Functions
************************************
Here are some modules.

The pyexample Module
======================
.. automodule:: pyexample

.. autoclass:: pyexample.TestClass
   :members:
...