Jak to katalog docs w dystrybucji Pythona

Question

Mam projektu Pythona w następującej strukturze:

Clustering (project name) 
    clustering (package) 
    clustering.py and other modules 
    tests (sub-package) 
     test_clustering.py and other such files 
    docs/ 
    bin/ 

chciałbym to katalog dokumentów na mojej dystrybucji, ale nie wydaje się to zrobić. Wszelkie wskazówki na temat tego, jak można to zrobić, byłyby bardzo pomocne.

Mój obecny setup.py wygląda następująco:

from distutils.core import setup 
setup(name='Clustering', 
     version='1.0', 
     description='desc', 
     author='A', 
     author_email='me@somemail.com', 
     packages=['clustering', 'clustering.tests'], 
     requires=['numpy', 'scipy'], 
     scripts=['bin/predict', 'bin/verify'] 
    ) 

Próbowałem za pomocą opcji package_data, ale nie udało się w tym katalogu docs w dystrybucji. Czy istnieje inny konwencjonalny sposób dołączania dokumentów do dystrybucji?

Answer 1

Musisz utworzyć plik MANIFEST.in i obejmują kilka prostych wskazówek na temat tego, co dodatkowo pliki chcesz dołączyć (Patrz MANIFEST.in Template)

Przykład (w tym docs dir i wszystkie pliki bezpośrednio pod):

include docs/* 

lub obejmować wszystkie pliki w katalogu doc ​​(rekurencyjnie):

recursive-include docs *