Sfenks kodumu 'html yap' komutunu çalıştırıyor mu?

Question

Ben html belgelerini oluşturmak istediğim oldukça büyük bir kod tabanı miras aldım. Python'da yazıldığından beri sfenks kullanmaya karar verdim, çünkü kodun kullanıcıları sfenks ile oluşturulan python-belgeselin tasarımına ve işlevselliğine alıştılar. Rst dosyalarını otomatik olarak oluşturmak için sphinx-apidoc komutunu kullandım. Sfenksin kodu bulabilmesi için modül yolunu sys.path'a aktardım. Şimdiye kadar çok iyi. Ancak, html'yi make html komutunu kullanarak oluşturmaya çalıştığımda, birçok tracebackin çıkması ve kod tabanındaki bazı örneklerin çalıştırılması gibi görünüyor. Bunun nedeni ne olabilir ve bunun olmasını nasıl engelleyebilirim?

Answer 1

autodoc kullanırken, Sphinx belgelenen modülleri içe aktarır, böylece tüm modül düzeyinde kod yürütülür. Bu her zaman "html yap" olur. Bu anlamda, Sphinx kodunuzu "çalıştırır".

Hataları değiştirmek için kodunuzu biraz farklı bir şekilde düzenlemeniz gerekebilir (modül düzeyi kodu işlevlere taşıyın). Ne olabileceğine bir örnek için bkz. this question.

Bu benim tahminimdir, ancak hikayenin tamamı olmayabilir. Ek bilgi olmadan daha fazla söylemek zor.

Answer 2

def main(): 

    print('hello world') 

if __name__ == '__main__': 

    main() 

Bu şekilde kodunuz çalışmaz.