mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
29da4f9444
While this feature is somewhat documented in the API guide, there's nothing about this option in the main user guide. Given the lack of blogs and articles talking about this feature, along with the amount of projects that are only using the same copy-paste '[build_sphinx]' definition, I imagine this is an issue. Make the feature a little more accessible by adding a section to the main user guide that details (a) the fact the feature exists, (b) why you'd want to use it, and (c) how you can use it. Signed-off-by: Stephen Finucane <stephen@that.guru>
50 lines
595 B
ReStructuredText
50 lines
595 B
ReStructuredText
|
|
.. _contents:
|
|
|
|
Sphinx documentation contents
|
|
=============================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
intro
|
|
tutorial
|
|
invocation
|
|
rest
|
|
markup/index
|
|
domains
|
|
builders
|
|
config
|
|
intl
|
|
theming
|
|
setuptools
|
|
templating
|
|
latex
|
|
markdown
|
|
extensions
|
|
extdev/index
|
|
websupport
|
|
|
|
faq
|
|
glossary
|
|
devguide
|
|
changes
|
|
examples
|
|
authors
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
.. only:: builder_html
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
* :ref:`glossary`
|
|
|
|
.. only:: not builder_html
|
|
|
|
* :ref:`modindex`
|
|
* :ref:`glossary`
|