IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Standardise on "reStructuredText" over "reST" in documentation

Browse Source
This commit is contained in:
Adam Turner
2024-07-14 06:00:08 +01:00
parent 26576590ed
commit f2640a4286
18 changed files with 111 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/faq.rst
View File

@@ -33,7 +33,7 @@ How do I...
See the :ref:`extension-tutorials-index`.
... convert from my existing docs using MoinMoin markup?
The easiest way is to convert to xhtml, then convert `xhtml to reST`_.
The easiest way is to convert to xhtml, then convert `xhtml to reStructuredText`_.
You'll still need to mark up classes and such, but the headings and code
examples come through cleanly.
@@ -58,8 +58,8 @@ Epydoc
Epydoc's API docs for a given identifier.
Doxygen
Michael Jones is developing a reST/Sphinx bridge to doxygen called `breathe
<https://github.com/michaeljones/breathe/tree/master>`_.
Michael Jones has developed a reStructuredText/Sphinx bridge to doxygen
called `breathe <https://github.com/breathe-doc/breathe/tree/master>`_.
SCons
Glenn Hutchings has written a SCons build script to build Sphinx
@@ -147,7 +147,7 @@ Google Search
.. _Getting Started: https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
.. _api role: https://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py
.. _xhtml to reST: https://docutils.sourceforge.io/sandbox/xhtml2rest/xhtml2rest.py
.. _xhtml to reStructuredText: https://docutils.sourceforge.io/sandbox/xhtml2rest/xhtml2rest.py
Sphinx vs. Docutils