Python dışı bir projeyi belgelemek için Sfenks kullanıyorum. Her alt modülde, bu modülü belgelemek için submodule_name.rst dosyalarını içeren ./doc klasörlerini dağıtmak istiyorum. Daha sonra tüm tasarım için bir özellik oluşturmak için bu dosyaları ana hiyerarşiye çekmek istiyorum.
Örneğin:
Proje dokümanları spec project_spec.rst conf.py modüller modül1 dokümanlar module1.rst src modül2 dokümanlar module2.rst src Dosyaları ana project_spec.rst belgesine şu şekilde dahil etmeye çalıştım:
.. toctree:: :numbered: :maxdepth: 2 Module 1 < ;../../modules/module1/docs/module1> Bununla birlikte şu hata mesajı ortaya çıkıyor:
UYARI: toctree, var olmayan u"modules/module1/docs/module1" belgesine referans içeriyor
Belge yolunda bir şekilde ../ kullanmak mümkün değil mi?
Güncelleme: conf.py konumu eklendi
Güncelleme : Aşağıdaki dahil etme hilesi dışında, bu hala (2019) mümkün değil. Devam eden açık bir sorun var: https://github.com/sphinx- doc/sfenks/issues/701