سؤال

كيف يمكنك إصلاح تحذير أبو الهول في الأسفل؟

أحاول الحصول على ملاحظات بايثون الخاصة بي في Sphinx.لدي ملاحظاتي في ملفات منفصلة على نفس مستوى الدليل مثل ملف مؤشر.rst.

أحصل على التحذيرات التالية بعد إنشاء HTML

التحذير

/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree

في

الرسالة الكاملة عند البناء

sudo sphinx-build -b html ./ _build/html
Running Sphinx v0.6.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 1 added, 2 changed, 0 removed
reading sources... [100%] trig_functions
/home/heo/S_codes/databooklet.rst:1: (WARNING/2) malformed hyperlink target.
/home/heo/S_codes/index.rst:11: (ERROR/3) Error in "toctree" directive:
invalid option block.

.. toctree::
   :numbered:
   :glob:
   *
   databooklet.rst
   trig_functions.rst


/home/heo/S_codes/trig_functions.rst:11: (ERROR/3) Unexpected indentation.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/heo/S_codes/databooklet.rst:: WARNING: document isn't included in any toctree
/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] trig_functions
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 6 warnings.
هل كانت مفيدة؟

المحلول

هل أنت على علم بتوثيق أبو الهول؟ http://sphinx.pocoo.org/contents.html

على وجه التحديد، اقرأ عن toctree التوجيه: http://sphinx.pocoo.org/concepts.html

يمكنك الحصول على العديد من الملفات كما تريد.عبر toctree يمكنك إنشاء مستند واحد من عدة أجزاء.


من فضلك في الواقع يقرأ هذا: http://sphinx.pocoo.org/concepts.html#document-names

نظرًا لأن ملفات مصدر REST يمكن أن تحتوي على امتدادات مختلفة (بعض الأشخاص مثل .txt ، بعضها مثل .rst - يمكن تكوين الامتداد باستخدام Source_suffix) وموزعات مختلفة لها فواصل مسار مختلفة ، يتجذها sphinx:جميع "أسماء المستندات" تتعلق بدليل المصدر ، ويتم تجريد التمديد ، ويتم تحويل فاصل المسار إلى مائلات.جميع القيم والمعلمات ومثل هذه الإشارة إلى "المستندات" تتوقع اسم المستند هذا.

ومن الأمثلة على أسماء المستندات index, library/zipfile, ، أو reference/datamodel/types.لاحظ أنه لا يوجد مائلة رائدة.

منذ أن كنت مثقلا مع *, ، لا تحتاج إلى سرد ملفاتك.

إذا كنت تريد سرد الملفات الخاصة بك، من فضلك فعلا يقرأ و يتبع القواعد المذكورة أعلاه.

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top