Both links in Contents are broken (404) or maybe it's the issue of compatibility between links on RTD and on GitHub?
In the second step of the Getting Started, it's not clear whether we need to declare
source_parsers and source_suffix for sphinx version 1.4+, or not. I suggest to split
the code block in two (and add syntax-highlighting):
# for Sphinx-1.4 or newer
extensions = ['recommonmark']
# for Sphinx-1.3
from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
It's not clear whether we need to define the setup function to add the AutoStructify transform or not, because the "Getting Started" section does not say so, but the "AutoStructify" one does (it seems we do need to define setup). I suggest to add a link to the "AutoStructify" paragraph as a step 3 in "Getting Started".
pawamoy
commented
4 years ago
Both links in Contents are broken (404) or maybe it's the issue of compatibility between links on RTD and on GitHub?
In the second step of the Getting Started, it's not clear whether we need to declare
source_parsersandsource_suffixfor sphinx version 1.4+, or not. I suggest to split the code block in two (and add syntax-highlighting):setupfunction to add theAutoStructifytransform or not, because the "Getting Started" section does not say so, but the "AutoStructify" one does (it seems we do need to definesetup). I suggest to add a link to the "AutoStructify" paragraph as a step 3 in "Getting Started".