Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rendering of toctree in restructured text #534

Closed
thomaszbz opened this issue Aug 9, 2015 · 3 comments
Closed

Add rendering of toctree in restructured text #534

thomaszbz opened this issue Aug 9, 2015 · 3 comments

Comments

@thomaszbz
Copy link

I think it would be of great benefit for readers if the table of contents in restructured text could be rendered. That would allow a preview of project documentation (e.g. for unstable branches) for developers as well as for users trying out unstable software or reading documentation for the next release.

My personal use case would be that I'd like to add a link to the documentation of the project's unstable branch in Readme.md. The project itself contains a sphinx project for documentation.

There's multiple ways to include additional files:

.. toctree::
   :maxdepth: 1

   Introduction1 <introduction1.rst>
   Introduction2.rst
   Introduction3
   Introduction4/Index

An example can be found here: https://github.com/mblaschke/TYPO3-metaseo/blob/develop/Documentation/Index.rst

@westurner
Copy link

👍

@jonathanunderwood
Copy link

This would be immensely helpful

@kivikakk
Copy link
Contributor

We're unlikely to add Sphinx custom directives to our rST implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants