@@ -1131,7 +1131,9 @@ <h3 id="selection">Selection<a class="headerlink" href="#selection" title="Perma
11311131</ table >
11321132< div class ="admonition example ">
11331133< p class ="admonition-title "> Configuration example</ p >
1134- < div class ="tabbed-set " data-tabs ="1:2 "> < input checked ="checked " id ="__tabbed_1_1 " name ="__tabbed_1 " type ="radio " /> < label for ="__tabbed_1_1 "> Global</ label > < div class ="tabbed-content ">
1134+ < div class ="tabbed-set tabbed-alternate " data-tabs ="1:2 "> < input checked ="checked " id ="__tabbed_1_1 " name ="__tabbed_1 " type ="radio " /> < input id ="__tabbed_1_2 " name ="__tabbed_1 " type ="radio " /> < div class ="tabbed-labels "> < label for ="__tabbed_1_1 "> Global</ label > < label for ="__tabbed_1_2 "> Local</ label > </ div >
1135+ < div class ="tabbed-content ">
1136+ < div class ="tabbed-block ">
11351137< div class ="highlight "> < pre > < span > </ span > < code > < span class ="c1 "> # mkdocs.yml</ span >
11361138< span class ="nt "> plugins</ span > < span class ="p "> :</ span >
11371139 < span class ="p p-Indicator "> -</ span > < span class ="nt "> mkdocstrings</ span > < span class ="p "> :</ span >
@@ -1143,14 +1145,15 @@ <h3 id="selection">Selection<a class="headerlink" href="#selection" title="Perma
11431145 < span class ="p p-Indicator "> -</ span > < span class ="s "> "^__init__$"</ span > < span class ="c1 "> # but always include __init__ modules and methods</ span >
11441146</ code > </ pre > </ div >
11451147</ div >
1146- < input id =" __tabbed_1_2 " name =" __tabbed_1 " type =" radio " /> < label for =" __tabbed_1_2 " > Local </ label > < div class ="tabbed-content ">
1148+ < div class ="tabbed-block ">
11471149< div class ="highlight "> < pre > < span > </ span > < code > < span class ="l l-Scalar l-Scalar-Plain "> ::</ span > < span class ="p p-Indicator "> :</ span > < span class ="l l-Scalar l-Scalar-Plain "> my_package</ span >
11481150 < span class ="l l-Scalar l-Scalar-Plain "> selection</ span > < span class ="p p-Indicator "> :</ span >
11491151 < span class ="nt "> filters</ span > < span class ="p "> :</ span > < span class ="p p-Indicator "> []</ span > < span class ="c1 "> # pick up everything</ span >
11501152</ code > </ pre > </ div >
11511153</ div >
11521154</ div >
11531155</ div >
1156+ </ div >
11541157< h3 id ="rendering "> Rendering< a class ="headerlink " href ="#rendering " title ="Permanent link "> ¤</ a > </ h3 >
11551158
11561159
@@ -1263,7 +1266,9 @@ <h3 id="rendering">Rendering<a class="headerlink" href="#rendering" title="Perma
12631266< p > These options affect how the documentation is rendered.</ p >
12641267< div class ="admonition example ">
12651268< p class ="admonition-title "> Configuration example</ p >
1266- < div class ="tabbed-set " data-tabs ="2:2 "> < input checked ="checked " id ="__tabbed_2_1 " name ="__tabbed_2 " type ="radio " /> < label for ="__tabbed_2_1 "> Global</ label > < div class ="tabbed-content ">
1269+ < div class ="tabbed-set tabbed-alternate " data-tabs ="2:2 "> < input checked ="checked " id ="__tabbed_2_1 " name ="__tabbed_2 " type ="radio " /> < input id ="__tabbed_2_2 " name ="__tabbed_2 " type ="radio " /> < div class ="tabbed-labels "> < label for ="__tabbed_2_1 "> Global</ label > < label for ="__tabbed_2_2 "> Local</ label > </ div >
1270+ < div class ="tabbed-content ">
1271+ < div class ="tabbed-block ">
12671272< div class ="highlight "> < pre > < span > </ span > < code > < span class ="c1 "> # mkdocs.yml</ span >
12681273< span class ="nt "> plugins</ span > < span class ="p "> :</ span >
12691274 < span class ="p p-Indicator "> -</ span > < span class ="nt "> mkdocstrings</ span > < span class ="p "> :</ span >
@@ -1273,7 +1278,7 @@ <h3 id="rendering">Rendering<a class="headerlink" href="#rendering" title="Perma
12731278 < span class ="nt "> show_root_heading</ span > < span class ="p "> :</ span > < span class ="l l-Scalar l-Scalar-Plain "> yes</ span >
12741279</ code > </ pre > </ div >
12751280</ div >
1276- < input id =" __tabbed_2_2 " name =" __tabbed_2 " type =" radio " /> < label for =" __tabbed_2_2 " > Local </ label > < div class ="tabbed-content ">
1281+ < div class ="tabbed-block ">
12771282< div class ="highlight "> < pre > < span > </ span > < code > < span class ="gu "> ## `ClassA`</ span >
12781283
12791284::: my_package.my_module.ClassA
@@ -1284,6 +1289,7 @@ <h3 id="rendering">Rendering<a class="headerlink" href="#rendering" title="Perma
12841289</ div >
12851290</ div >
12861291</ div >
1292+ </ div >
12871293< h2 id ="collector-pytkdocs "> Collector: pytkdocs< a class ="headerlink " href ="#collector-pytkdocs " title ="Permanent link "> ¤</ a > </ h2 >
12881294< p > The tool used by the Python handler to collect documentation from Python source code
12891295is < a href ="https://pawamoy.github.io/pytkdocs "> < code > pytkdocs</ code > </ a > .
@@ -1310,7 +1316,9 @@ <h5 id="sections">Sections<a class="headerlink" href="#sections" title="Permanen
13101316< h5 id ="admonitions "> Admonitions< a class ="headerlink " href ="#admonitions " title ="Permanent link "> ¤</ a > </ h5 >
13111317< p > Additionally, any section that is not recognized will be transformed into its admonition equivalent.
13121318For example:</ p >
1313- < div class ="tabbed-set " data-tabs ="3:3 "> < input checked ="checked " id ="__tabbed_3_1 " name ="__tabbed_3 " type ="radio " /> < label for ="__tabbed_3_1 "> Original</ label > < div class ="tabbed-content ">
1319+ < div class ="tabbed-set tabbed-alternate " data-tabs ="3:3 "> < input checked ="checked " id ="__tabbed_3_1 " name ="__tabbed_3 " type ="radio " /> < input id ="__tabbed_3_2 " name ="__tabbed_3 " type ="radio " /> < input id ="__tabbed_3_3 " name ="__tabbed_3 " type ="radio " /> < div class ="tabbed-labels "> < label for ="__tabbed_3_1 "> Original</ label > < label for ="__tabbed_3_2 "> Modified</ label > < label for ="__tabbed_3_3 "> Result</ label > </ div >
1320+ < div class ="tabbed-content ">
1321+ < div class ="tabbed-block ">
13141322< div class ="highlight "> < pre > < span > </ span > < code > < span class ="sd "> """</ span >
13151323< span class ="sd "> Note: You can disable this behavior with the `replace_admonitions` option.</ span >
13161324< span class ="sd "> To prevent `pytkdocs` from converting sections to admonitions,</ span >
@@ -1328,7 +1336,7 @@ <h5 id="admonitions">Admonitions<a class="headerlink" href="#admonitions" title=
13281336< span class ="sd "> """</ span >
13291337</ code > </ pre > </ div >
13301338</ div >
1331- < input id =" __tabbed_3_2 " name =" __tabbed_3 " type =" radio " /> < label for =" __tabbed_3_2 " > Modified </ label > < div class ="tabbed-content ">
1339+ < div class ="tabbed-block ">
13321340< div class ="highlight "> < pre > < span > </ span > < code > < span class ="sd "> """</ span >
13331341< span class ="sd "> !!! note "You can disable this behavior with the `replace_admonitions` option."</ span >
13341342< span class ="sd "> To prevent `pytkdocs` from converting sections to admonitions,</ span >
@@ -1346,7 +1354,7 @@ <h5 id="admonitions">Admonitions<a class="headerlink" href="#admonitions" title=
13461354< span class ="sd "> """</ span >
13471355</ code > </ pre > </ div >
13481356</ div >
1349- < input id =" __tabbed_3_3 " name =" __tabbed_3 " type =" radio " /> < label for =" __tabbed_3_3 " > Result </ label > < div class ="tabbed-content ">
1357+ < div class ="tabbed-block ">
13501358< div class ="admonition note ">
13511359< p class ="admonition-title "> You can disable this behavior with the < code > replace_admonitions</ code > parser option.</ p >
13521360< p > To prevent < code > pytkdocs</ code > from converting sections to admonitions,
@@ -1361,6 +1369,7 @@ <h5 id="admonitions">Admonitions<a class="headerlink" href="#admonitions" title=
13611369</ div >
13621370</ div >
13631371</ div >
1372+ </ div >
13641373< p > As shown in the above example, this can be disabled
13651374with the < code > replace_admonitions</ code > option of the Google-style parser:</ p >
13661375< div class ="highlight "> < pre > < span > </ span > < code > < span class ="l l-Scalar l-Scalar-Plain "> ::</ span > < span class ="p p-Indicator "> :</ span > < span class ="l l-Scalar l-Scalar-Plain "> my_package.my_module</ span >
0 commit comments