hiro/recommonmark
1
0
Fork 0
mirror of https://github.com/vale981/recommonmark synced 2025-03-05 10:01:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify the specifics of Auto Toc Tree

Browse source 
Removes a double-up-on-the-verb situation.
This commit is contained in:
Anne Gentle 2019-04-04 08:34:14 -05:00 • committed by GitHub
parent 815d75ea50
commit 4ad6e66e94
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/auto_structify.md
View file

@ -38,13 +38,13 @@ One of important command in tools like sphinx is `toctree`. This is a command to
tell sphinx about the structure of the documents. In markdown, usually we manually list of contents by a bullet list tell sphinx about the structure of the documents. In markdown, usually we manually list of contents by a bullet list
of url reference to the other documents. of url reference to the other documents.
AutoStructify will transforms bullet list of document URLs AutoStructify transforms bullet list of document URLs like this
``` ```
* [Title1](doc1.md) * [Title1](doc1.md)
* [Title2](doc2.md) * [Title2](doc2.md)
``` ```
will be translated to the AST of following reStructuredText code to the AST of this following reStructuredText code
```rst ```rst
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1