繁体   English   中英

为狮身人面像组织.rst文件吗?

[英]Organise .rst files for sphinx?

我正在整理一些使用Sphinx的用户指南。 但是,有许多.rst文件,当它们与index.rst一起位于主文件夹中时,要跟踪它们已经变得非常困难。

我想像这样将它们整理到文件夹中。 但是随后, make html命令导致警告,提示它找不到藏在文件夹中的所有那些.rst文件。

如何组织.rst文件?

index.rst
  Docs
     new_starter.rst
     subject_guides.rst
  New starter
     first_week.rst
     second_week.rst
  Subject guides
     stress.rst
     aerodynamics.rst
     data_science.rst

Sphinx文档部分TOC Tree中提到了这一点。

index.rst ,使用toctree指令:

Project Awesome
===============

Welcome to the Project Awesome docs.

.. toctree::
   :glob:
   :maxdepth: 2

   docs/*
   new_starter/*
   subject_guides/*

上面使用了“ globbing”,但是您可以使用文件名而不是glob显式地对文件进行排序。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM