Offset 1, 9 lines modified | Offset 1, 9 lines modified | ||
1 | -rw-r--r--···0·root·········(0)·root·········(0)·····8433·2023-12-06·21:43:29.000000·.BUILDINFO | 1 | -rw-r--r--···0·root·········(0)·root·········(0)·····8433·2023-12-06·21:43:29.000000·.BUILDINFO |
2 | -rw-r--r--···0·root·········(0)·root·········(0)····5990 | 2 | -rw-r--r--···0·root·········(0)·root·········(0)····59904·2023-12-06·21:43:29.000000·.MTREE |
3 | -rw-r--r--···0·root·········(0)·root·········(0)·····1381·2023-12-06·21:43:29.000000·.PKGINFO | 3 | -rw-r--r--···0·root·········(0)·root·········(0)·····1381·2023-12-06·21:43:29.000000·.PKGINFO |
4 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/ | 4 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/ |
5 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/bin/ | 5 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/bin/ |
6 | -rwxr-xr-x···0·root·········(0)·root·········(0)······216·2023-12-06·21:43:29.000000·usr/bin/sphinx-apidoc | 6 | -rwxr-xr-x···0·root·········(0)·root·········(0)······216·2023-12-06·21:43:29.000000·usr/bin/sphinx-apidoc |
7 | -rwxr-xr-x···0·root·········(0)·root·········(0)······230·2023-12-06·21:43:29.000000·usr/bin/sphinx-autogen | 7 | -rwxr-xr-x···0·root·········(0)·root·········(0)······230·2023-12-06·21:43:29.000000·usr/bin/sphinx-autogen |
8 | -rwxr-xr-x···0·root·········(0)·root·········(0)······215·2023-12-06·21:43:29.000000·usr/bin/sphinx-build | 8 | -rwxr-xr-x···0·root·········(0)·root·········(0)······215·2023-12-06·21:43:29.000000·usr/bin/sphinx-build |
9 | -rwxr-xr-x···0·root·········(0)·root·········(0)······220·2023-12-06·21:43:29.000000·usr/bin/sphinx-quickstart | 9 | -rwxr-xr-x···0·root·········(0)·root·········(0)······220·2023-12-06·21:43:29.000000·usr/bin/sphinx-quickstart |
Offset 1150, 12 lines modified | Offset 1150, 12 lines modified | ||
1150 | -rw-r--r--···0·root·········(0)·root·········(0)·····1509·2023-12-06·21:43:29.000000·usr/lib/python3.11/site-packages/sphinx/writers/xml.py | 1150 | -rw-r--r--···0·root·········(0)·root·········(0)·····1509·2023-12-06·21:43:29.000000·usr/lib/python3.11/site-packages/sphinx/writers/xml.py |
1151 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/ | 1151 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/ |
1152 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/licenses/ | 1152 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/licenses/ |
1153 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/licenses/python-sphinx/ | 1153 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/licenses/python-sphinx/ |
1154 | lrwxrwxrwx···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/licenses/python-sphinx/LICENSE·->·/usr/lib/python3.11/site-packages/sphinx-7.2.6.dist-info/LICENSE | 1154 | lrwxrwxrwx···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/licenses/python-sphinx/LICENSE·->·/usr/lib/python3.11/site-packages/sphinx-7.2.6.dist-info/LICENSE |
1155 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/man/ | 1155 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/man/ |
1156 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/man/man1/ | 1156 | drwxr-xr-x···0·root·········(0)·root·········(0)········0·2023-12-06·21:43:29.000000·usr/share/man/man1/ |
1157 | -rwxr-xr-x···0·root·········(0)·root·········(0)···372 | 1157 | -rwxr-xr-x···0·root·········(0)·root·········(0)···372290·2023-12-06·21:43:29.000000·usr/share/man/man1/sphinx-all.1.gz |
1158 | -rwxr-xr-x···0·root·········(0)·root·········(0)·····2107·2023-12-06·21:43:29.000000·usr/share/man/man1/sphinx-apidoc.1.gz | 1158 | -rwxr-xr-x···0·root·········(0)·root·········(0)·····2107·2023-12-06·21:43:29.000000·usr/share/man/man1/sphinx-apidoc.1.gz |
1159 | -rwxr-xr-x···0·root·········(0)·root·········(0)·····122 | 1159 | -rwxr-xr-x···0·root·········(0)·root·········(0)·····1225·2023-12-06·21:43:29.000000·usr/share/man/man1/sphinx-autogen.1.gz |
1160 | -rwxr-xr-x···0·root·········(0)·root·········(0)·····431 | 1160 | -rwxr-xr-x···0·root·········(0)·root·········(0)·····4310·2023-12-06·21:43:29.000000·usr/share/man/man1/sphinx-build.1.gz |
1161 | -rwxr-xr-x···0·root·········(0)·root·········(0)·····1664·2023-12-06·21:43:29.000000·usr/share/man/man1/sphinx-quickstart.1.gz | 1161 | -rwxr-xr-x···0·root·········(0)·root·········(0)·····1664·2023-12-06·21:43:29.000000·usr/share/man/man1/sphinx-quickstart.1.gz |
Offset 1, 11 lines modified | Offset 1, 11 lines modified | ||
1 | #mtree | 1 | #mtree |
2 | /set·type=file·uid=0·gid=0·mode=644 | 2 | /set·type=file·uid=0·gid=0·mode=644 |
3 | ./.BUILDINFO·time=1701899009.0·size=8433·md5digest=e6d8d98ec899b23025406f08d9ab7d5c·sha256digest=0bbb2f4b320cc32a28fd32a77ef5ade01269fd56330393c51c468028e1c8e0f1 | 3 | ./.BUILDINFO·time=1701899009.0·size=8433·md5digest=e6d8d98ec899b23025406f08d9ab7d5c·sha256digest=0bbb2f4b320cc32a28fd32a77ef5ade01269fd56330393c51c468028e1c8e0f1 |
4 | ./.PKGINFO·time=1701899009.0·size=1381·md5digest= | 4 | ./.PKGINFO·time=1701899009.0·size=1381·md5digest=e75e2805d3bee72743824b7f7dafdd89·sha256digest=b84b8ea6656a241f3e06d1ad149208c9611fe04ab4101d0122db537cb3f5de44 |
5 | /set·mode=755 | 5 | /set·mode=755 |
6 | ./usr·time=1701899009.0·type=dir | 6 | ./usr·time=1701899009.0·type=dir |
7 | ./usr/bin·time=1701899009.0·type=dir | 7 | ./usr/bin·time=1701899009.0·type=dir |
8 | ./usr/bin/sphinx-apidoc·time=1701899009.0·size=216·md5digest=15727a54f6f964ce2f685d75abff3f32·sha256digest=904160cce8d8249edc68aefb2e5f098ef82ec34ed97430656321b33bfb674a19 | 8 | ./usr/bin/sphinx-apidoc·time=1701899009.0·size=216·md5digest=15727a54f6f964ce2f685d75abff3f32·sha256digest=904160cce8d8249edc68aefb2e5f098ef82ec34ed97430656321b33bfb674a19 |
9 | ./usr/bin/sphinx-autogen·time=1701899009.0·size=230·md5digest=165502d4a4ef7b23e2b8d4c4ee1a833a·sha256digest=f93814f79c428bd69bd74f1ef06ee7b12ace797209779dc2db53cc8a64b112b4 | 9 | ./usr/bin/sphinx-autogen·time=1701899009.0·size=230·md5digest=165502d4a4ef7b23e2b8d4c4ee1a833a·sha256digest=f93814f79c428bd69bd74f1ef06ee7b12ace797209779dc2db53cc8a64b112b4 |
10 | ./usr/bin/sphinx-build·time=1701899009.0·size=215·md5digest=401323feb587db87edc03b527d22c8be·sha256digest=0ac1abef754844e49b43d5c236286b753a46d4b5a9ea9a2cb978dd6df0f9ecfb | 10 | ./usr/bin/sphinx-build·time=1701899009.0·size=215·md5digest=401323feb587db87edc03b527d22c8be·sha256digest=0ac1abef754844e49b43d5c236286b753a46d4b5a9ea9a2cb978dd6df0f9ecfb |
11 | ./usr/bin/sphinx-quickstart·time=1701899009.0·size=220·md5digest=7083f7dbb0c14e72dc3b0c9a46911b6f·sha256digest=accf0ee97086f294dc337f7b556e9ae610fbb2a4e267a33b2fa12048485d1fcf | 11 | ./usr/bin/sphinx-quickstart·time=1701899009.0·size=220·md5digest=7083f7dbb0c14e72dc3b0c9a46911b6f·sha256digest=accf0ee97086f294dc337f7b556e9ae610fbb2a4e267a33b2fa12048485d1fcf |
Offset 1164, 12 lines modified | Offset 1164, 12 lines modified | ||
1164 | /set·mode=755 | 1164 | /set·mode=755 |
1165 | ./usr/share·time=1701899009.0·type=dir | 1165 | ./usr/share·time=1701899009.0·type=dir |
1166 | ./usr/share/licenses·time=1701899009.0·type=dir | 1166 | ./usr/share/licenses·time=1701899009.0·type=dir |
1167 | ./usr/share/licenses/python-sphinx·time=1701899009.0·type=dir | 1167 | ./usr/share/licenses/python-sphinx·time=1701899009.0·type=dir |
1168 | ./usr/share/licenses/python-sphinx/LICENSE·time=1701899009.0·mode=777·type=link·link=/usr/lib/python3.11/site-packages/sphinx-7.2.6.dist-info/LICENSE | 1168 | ./usr/share/licenses/python-sphinx/LICENSE·time=1701899009.0·mode=777·type=link·link=/usr/lib/python3.11/site-packages/sphinx-7.2.6.dist-info/LICENSE |
1169 | ./usr/share/man·time=1701899009.0·type=dir | 1169 | ./usr/share/man·time=1701899009.0·type=dir |
1170 | ./usr/share/man/man1·time=1701899009.0·type=dir | 1170 | ./usr/share/man/man1·time=1701899009.0·type=dir |
1171 | ./usr/share/man/man1/sphinx-all.1.gz·time=1701899009.0·size=372 | 1171 | ./usr/share/man/man1/sphinx-all.1.gz·time=1701899009.0·size=372290·md5digest=2e24679c53a3090151709cb6dd5ada9e·sha256digest=628f22cf0638c4e6718a134a0dc3e2c1e7fd4f5f067b434b58e9c181055bd7d6 |
1172 | ./usr/share/man/man1/sphinx-apidoc.1.gz·time=1701899009.0·size=2107·md5digest=fc79977bc50c06b3c3ab2d1bad92c69b·sha256digest=3ee20bdce3bc5cbc3c22be61946664f3c6377dcfebbe3b6bad8c1d5a6b208e65 | 1172 | ./usr/share/man/man1/sphinx-apidoc.1.gz·time=1701899009.0·size=2107·md5digest=fc79977bc50c06b3c3ab2d1bad92c69b·sha256digest=3ee20bdce3bc5cbc3c22be61946664f3c6377dcfebbe3b6bad8c1d5a6b208e65 |
1173 | ./usr/share/man/man1/sphinx-autogen.1.gz·time=1701899009.0·size=1224·md5digest=9b99e6c971f4ce8d2d2f5fca23d49e8b·sha256digest=d05a074215344152264a15f74a02bb605d5258f06aca12e324df80c5801881ad | ||
1174 | ./usr/share/man/man1/sphinx- | 1173 | ./usr/share/man/man1/sphinx-autogen.1.gz·time=1701899009.0·size=1225·md5digest=4cf0e9f10a72e139f8248a7963836188·sha256digest=7657f3f14c8a2475db43aeb41ea91a0472c75de56165245523d0a9c69c9919b1 |
1174 | ./usr/share/man/man1/sphinx-build.1.gz·time=1701899009.0·size=4310·md5digest=5c61511d84140313ef3259fde185285e·sha256digest=60f33c22d15eb0e0fa2546deb9872caa70c51e575e245446ff14fc3e06366263 | ||
1175 | ./usr/share/man/man1/sphinx-quickstart.1.gz·time=1701899009.0·size=1664·md5digest=5f6f20de1d356b2fd88619f7eef5942e·sha256digest=ac8640ad98517e7c33a7e5e8bf7c83b677b3dbab08116ce65f9ebf0e62af8149 | 1175 | ./usr/share/man/man1/sphinx-quickstart.1.gz·time=1701899009.0·size=1664·md5digest=5f6f20de1d356b2fd88619f7eef5942e·sha256digest=ac8640ad98517e7c33a7e5e8bf7c83b677b3dbab08116ce65f9ebf0e62af8149 |
Offset 3, 15 lines modified | Offset 3, 15 lines modified | ||
3 | pkgname·=·python-sphinx | 3 | pkgname·=·python-sphinx |
4 | pkgbase·=·python-sphinx | 4 | pkgbase·=·python-sphinx |
5 | pkgver·=·7.2.6-1 | 5 | pkgver·=·7.2.6-1 |
6 | pkgdesc·=·Python·documentation·generator | 6 | pkgdesc·=·Python·documentation·generator |
7 | url·=·http://www.sphinx-doc.org/ | 7 | url·=·http://www.sphinx-doc.org/ |
8 | builddate·=·1701899009 | 8 | builddate·=·1701899009 |
9 | packager·=·Reproducible·Arch·Linux·tests·<reproducible@archlinux.org> | 9 | packager·=·Reproducible·Arch·Linux·tests·<reproducible@archlinux.org> |
10 | size·=·1983 | 10 | size·=·19831977 |
11 | arch·=·any | 11 | arch·=·any |
12 | license·=·BSD | 12 | license·=·BSD |
13 | depend·=·python-babel | 13 | depend·=·python-babel |
14 | depend·=·python-docutils | 14 | depend·=·python-docutils |
15 | depend·=·python-imagesize | 15 | depend·=·python-imagesize |
16 | depend·=·python-jinja | 16 | depend·=·python-jinja |
17 | depend·=·python-packaging | 17 | depend·=·python-packaging |
Offset 356, 15 lines modified | Offset 356, 15 lines modified | ||
356 | and·their·directives/roles. | 356 | and·their·directives/roles. |
357 | .SS·Basic·configuration | 357 | .SS·Basic·configuration |
358 | .sp | 358 | .sp |
359 | Earlier·we·mentioned·that·the·\fBconf.py\fP·file·controls·how·Sphinx | 359 | Earlier·we·mentioned·that·the·\fBconf.py\fP·file·controls·how·Sphinx |
360 | processes·your·documents.··In·that·file,·which·is·executed·as·a·Python·source | 360 | processes·your·documents.··In·that·file,·which·is·executed·as·a·Python·source |
361 | file,·you·assign·configuration·values.··For·advanced·users:·since·it·is | 361 | file,·you·assign·configuration·values.··For·advanced·users:·since·it·is |
362 | executed·by·Sphinx,·you·can·do·non\-trivial·tasks·in·it,·like·extending | 362 | executed·by·Sphinx,·you·can·do·non\-trivial·tasks·in·it,·like·extending |
363 | \f | 363 | \fBsys.path\fP·or·importing·a·module·to·find·out·the·version·you·are |
364 | documenting. | 364 | documenting. |
365 | .sp | 365 | .sp |
366 | The·config·values·that·you·probably·want·to·change·are·already·put·into·the | 366 | The·config·values·that·you·probably·want·to·change·are·already·put·into·the |
367 | \fBconf.py\fP·by·\fBsphinx\-quickstart\fP·and·initially·commented·out | 367 | \fBconf.py\fP·by·\fBsphinx\-quickstart\fP·and·initially·commented·out |
368 | (with·standard·Python·syntax:·a·\fB#\fP·comments·the·rest·of·the·line).··To | 368 | (with·standard·Python·syntax:·a·\fB#\fP·comments·the·rest·of·the·line).··To |
369 | change·the·default·value,·remove·the·hash·sign·and·modify·the·value.··To | 369 | change·the·default·value,·remove·the·hash·sign·and·modify·the·value.··To |
370 | customize·a·config·value·that·is·not·automatically·added·by | 370 | customize·a·config·value·that·is·not·automatically·added·by |
Offset 431, 15 lines modified | Offset 431, 15 lines modified | ||
431 | ···:members: | 431 | ···:members: |
432 | .ft·P | 432 | .ft·P |
433 | .fi | 433 | .fi |
434 | .UNINDENT | 434 | .UNINDENT |
435 | .UNINDENT | 435 | .UNINDENT |
436 | .sp | 436 | .sp |
437 | \fIautodoc\fP·needs·to·import·your·modules·in·order·to·extract·the·docstrings. | 437 | \fIautodoc\fP·needs·to·import·your·modules·in·order·to·extract·the·docstrings. |
438 | Therefore,·you·must·add·the·appropriate·path·to·\f | 438 | Therefore,·you·must·add·the·appropriate·path·to·\fBsys.path\fP·in·your |
439 | \fBconf.py\fP\&. | 439 | \fBconf.py\fP\&. |
440 | .sp | 440 | .sp |
441 | \fBWARNING:\fP | 441 | \fBWARNING:\fP |
442 | .INDENT·0.0 | 442 | .INDENT·0.0 |
443 | .INDENT·3.5 | 443 | .INDENT·3.5 |
444 | \fI\%autodoc\fP·\fBimports\fP·the·modules·to·be·documented.··If·any | 444 | \fI\%autodoc\fP·\fBimports\fP·the·modules·to·be·documented.··If·any |
445 | modules·have·side·effects·on·import,·these·will·be·executed·by·\fBautodoc\fP | 445 | modules·have·side·effects·on·import,·these·will·be·executed·by·\fBautodoc\fP |
Offset 1591, 15 lines modified | Offset 1591, 15 lines modified | ||
1591 | .fi | 1591 | .fi |
1592 | .UNINDENT | 1592 | .UNINDENT |
1593 | .UNINDENT | 1593 | .UNINDENT |
1594 | .sp | 1594 | .sp |
1595 | \fBNOTE:\fP | 1595 | \fBNOTE:\fP |
1596 | .INDENT·0.0 | 1596 | .INDENT·0.0 |
1597 | .INDENT·3.5 | 1597 | .INDENT·3.5 |
1598 | An·alternative·to·changing·the·\f | 1598 | An·alternative·to·changing·the·\fBsys.path\fP·variable·is·to·create·a |
1599 | \fBpyproject.toml\fP·file·and·make·the·code·installable, | 1599 | \fBpyproject.toml\fP·file·and·make·the·code·installable, |
1600 | so·it·behaves·like·any·other·Python·library.·However,·the·\fBsys.path\fP | 1600 | so·it·behaves·like·any·other·Python·library.·However,·the·\fBsys.path\fP |
1601 | approach·is·simpler. | 1601 | approach·is·simpler. |
1602 | .UNINDENT | 1602 | .UNINDENT |
1603 | .UNINDENT | 1603 | .UNINDENT |
1604 | .sp | 1604 | .sp |
1605 | Then,·before·adding·doctests·to·your·documentation,·enable·the | 1605 | Then,·before·adding·doctests·to·your·documentation,·enable·the |
Offset 2122, 19 lines modified | Offset 2122, 19 lines modified | ||
2122 | only·the·web | 2122 | only·the·web |
2123 | interface\fP·is | 2123 | interface\fP·is |
2124 | not·yet·implemented. | 2124 | not·yet·implemented. |
2125 | .SS·Publishing·your·HTML·documentation | 2125 | .SS·Publishing·your·HTML·documentation |
2126 | .SS·Read·the·Docs | 2126 | .SS·Read·the·Docs |
2127 | .sp | 2127 | .sp |
2128 | \fI\%Read·the·Docs\fP·offers·integration·with·both·GitHub·and·GitLab.·The·quickest | 2128 | \fI\%Read·the·Docs\fP·offers·integration·with·both·GitHub·and·GitLab.·The·quickest |
2129 | way·of·getting·started·is·to·follow· | 2129 | way·of·getting·started·is·to·follow·the·RTD |
2130 | tutorial | 2130 | tutorial,·which·is·loosely·based·on·this·one. |
2131 | You·can·publish·your·sources·on·GitHub·as·explained·\fI\%in·the·previous | 2131 | You·can·publish·your·sources·on·GitHub·as·explained·\fI\%in·the·previous |
2132 | section\fP,·then·skip·directly·to | 2132 | section\fP,·then·skip·directly·to |
2133 | 2133 | readthedocs:tutorial/index:Sign·up·for·Read·the·Docs\&. | |
2134 | If·you·choose·GitLab·instead,·the·process·is·similar. | 2134 | If·you·choose·GitLab·instead,·the·process·is·similar. |
2135 | .SS·GitHub·Pages | 2135 | .SS·GitHub·Pages |
2136 | .sp | 2136 | .sp |
2137 | \fI\%GitHub·Pages\fP·requires·you·to·\fI\%publish·your | 2137 | \fI\%GitHub·Pages\fP·requires·you·to·\fI\%publish·your |
2138 | sources\fP·on·\fI\%GitHub\fP\&.·After·that,·you·will·need·an | 2138 | sources\fP·on·\fI\%GitHub\fP\&.·After·that,·you·will·need·an |
2139 | automated·process·that·performs·the·\fBmake·html\fP·step·every·time·the·sources | 2139 | automated·process·that·performs·the·\fBmake·html\fP·step·every·time·the·sources |
2140 | change.·That·can·be·achieved·using·\fI\%GitHub·Actions\fP\&. | 2140 | change.·That·can·be·achieved·using·\fI\%GitHub·Actions\fP\&. |
Offset 3541, 15 lines modified | Offset 3541, 15 lines modified | ||
3541 | indicate·that·it·is·to·be·replaced·by·the·Python·minor·version. | 3541 | indicate·that·it·is·to·be·replaced·by·the·Python·minor·version. |
3542 | .UNINDENT | 3542 | .UNINDENT |
3543 | .INDENT·0.0 | 3543 | .INDENT·0.0 |
3544 | .TP | 3544 | .TP |
3545 | .B·:guilabel: | 3545 | .B·:guilabel: |
3546 | Labels·presented·as·part·of·an·interactive·user·interface·should·be·marked | 3546 | Labels·presented·as·part·of·an·interactive·user·interface·should·be·marked |
3547 | using·\fBguilabel\fP\&.··This·includes·labels·from·text\-based·interfaces·such·as | 3547 | using·\fBguilabel\fP\&.··This·includes·labels·from·text\-based·interfaces·such·as |
3548 | those·created·using·\f | 3548 | those·created·using·\fBcurses\fP·or·other·text\-based·libraries.··Any·label |
3549 | used·in·the·interface·should·be·marked·with·this·role,·including·button | 3549 | used·in·the·interface·should·be·marked·with·this·role,·including·button |
3550 | labels,·window·titles,·field·names,·menu·and·menu·selection·names,·and·even | 3550 | labels,·window·titles,·field·names,·menu·and·menu·selection·names,·and·even |
3551 | values·in·selection·lists. | 3551 | values·in·selection·lists. |
3552 | .sp | 3552 | .sp |
3553 | Changed·in·version·1.0:·An·accelerator·key·for·the·GUI·label·can·be·included·using·an·ampersand; | 3553 | Changed·in·version·1.0:·An·accelerator·key·for·the·GUI·label·can·be·included·using·an·ampersand; |
3554 | this·will·be·stripped·and·displayed·underlined·in·the·output·(for·example: | 3554 | this·will·be·stripped·and·displayed·underlined·in·the·output·(for·example: |
3555 | \fB:guilabel:\(ga&Cancel\(ga\fP·displays·Cancel).··To·include·a·literal | 3555 | \fB:guilabel:\(ga&Cancel\(ga\fP·displays·Cancel).··To·include·a·literal |
Offset 4557, 15 lines modified | Offset 4557, 15 lines modified | ||
4557 | .UNINDENT | 4557 | .UNINDENT |
4558 | .INDENT·7.0 | 4558 | .INDENT·7.0 |
4559 | .TP | 4559 | .TP |
4560 | .B·:dedent:·number·(number·or·no·value) | 4560 | .B·:dedent:·number·(number·or·no·value) |
4561 | Strip·indentation·characters·from·the·code·block.··When·number·given, | 4561 | Strip·indentation·characters·from·the·code·block.··When·number·given, |
4562 | leading·N·characters·are·removed.··When·no·argument·given,·leading·spaces | 4562 | leading·N·characters·are·removed.··When·no·argument·given,·leading·spaces |
4563 | are·removed·via·\f | 4563 | are·removed·via·\fBtextwrap.dedent()\fP\&.··For·example: |
4564 | .INDENT·7.0 | 4564 | .INDENT·7.0 |
4565 | .INDENT·3.5 | 4565 | .INDENT·3.5 |
4566 | .sp | 4566 | .sp |
4567 | .nf | 4567 | .nf |
4568 | .ft·C | 4568 | .ft·C |
4569 | \&..·code\-block::·ruby | 4569 | \&..·code\-block::·ruby |
4570 | ···:linenos: | 4570 | ···:linenos: |
Offset 6479, 35 lines modified | Offset 6479, 35 lines modified | ||
6479 | .B·send_message(sender,·recipient,·message_body[,·priority=1]) | 6479 | .B·send_message(sender,·recipient,·message_body[,·priority=1]) |
6480 | Send·a·message·to·a·recipient | 6480 | Send·a·message·to·a·recipient |
6481 | .INDENT·7.0 | 6481 | .INDENT·7.0 |
6482 | .TP | 6482 | .TP |
6483 | .B·Parameters | 6483 | .B·Parameters |
6484 | .INDENT·7.0 | 6484 | .INDENT·7.0 |
6485 | .IP·\(bu·2 | 6485 | .IP·\(bu·2 |
6486 | \fBsender\fP·(\fI | 6486 | \fBsender\fP·(\fIstr\fP)·\-\-·The·person·sending·the·message |
6487 | .IP·\(bu·2 | 6487 | .IP·\(bu·2 |
6488 | \fBrecipient\fP·(\fI | 6488 | \fBrecipient\fP·(\fIstr\fP)·\-\-·The·recipient·of·the·message |
6489 | .IP·\(bu·2 | 6489 | .IP·\(bu·2 |
6490 | \fBmessage_body\fP·(\fI | 6490 | \fBmessage_body\fP·(\fIstr\fP)·\-\-·The·body·of·the·message |
6491 | .IP·\(bu·2 | 6491 | .IP·\(bu·2 |
6492 | \fBpriority\fP·(\fI | 6492 | \fBpriority\fP·(\fIint\fP\fI·or·\fP\fINone\fP)·\-\-·The·priority·of·the·message,·can·be·a·number·1\-5 |
6493 | .UNINDENT | 6493 | .UNINDENT |
6494 | .TP | 6494 | .TP |
6495 | .B·Returns | 6495 | .B·Returns |
6496 | the·message·id | 6496 | the·message·id |
6497 | .TP | 6497 | .TP |
6498 | .B·Return·type | 6498 | .B·Return·type |
6499 | 6499 | int | |
6500 | .TP | 6500 | .TP |
6501 | .B·Raises | 6501 | .B·Raises |
6502 | .INDENT·7.0 | 6502 | .INDENT·7.0 |
6503 | .IP·\(bu·2 | 6503 | .IP·\(bu·2 |
6504 | \f | 6504 | \fBValueError\fP·\-\-·if·the·message_body·exceeds·160·characters |
6505 | .IP·\(bu·2 | 6505 | .IP·\(bu·2 |
Max diff block lines reached; 96121/101501 bytes (94.70%) of diff not shown. |
Offset 37, 15 lines modified | Offset 37, 15 lines modified | ||
37 | .sp | 37 | .sp |
38 | \fBsphinx\-autogen\fP·is·a·tool·for·automatic·generation·of·Sphinx·sources | 38 | \fBsphinx\-autogen\fP·is·a·tool·for·automatic·generation·of·Sphinx·sources |
39 | that,·using·the·\fI\%autodoc\fP·extension,·document·items·included | 39 | that,·using·the·\fI\%autodoc\fP·extension,·document·items·included |
40 | in·\fI\%autosummary\fP·listing(s). | 40 | in·\fI\%autosummary\fP·listing(s). |
41 | .sp | 41 | .sp |
42 | \fIsourcefile\fP·is·the·path·to·one·or·more·reStructuredText·documents·containing | 42 | \fIsourcefile\fP·is·the·path·to·one·or·more·reStructuredText·documents·containing |
43 | \fI\%autosummary\fP·entries·with·the·\fB:toctree::\fP·option·set.·\fIsourcefile\fP | 43 | \fI\%autosummary\fP·entries·with·the·\fB:toctree::\fP·option·set.·\fIsourcefile\fP |
44 | can·be·an·\f | 44 | can·be·an·\fBfnmatch\fP\-style·pattern. |
45 | .SH·OPTIONS | 45 | .SH·OPTIONS |
46 | .INDENT·0.0 | 46 | .INDENT·0.0 |
47 | .TP | 47 | .TP |
48 | .B·\-o·<outputdir> | 48 | .B·\-o·<outputdir> |
49 | Directory·to·place·the·output·file.·If·it·does·not·exist,·it·is·created. | 49 | Directory·to·place·the·output·file.·If·it·does·not·exist,·it·is·created. |
50 | Defaults·to·the·value·passed·to·the·\fB:toctree:\fP·option. | 50 | Defaults·to·the·value·passed·to·the·\fB:toctree:\fP·option. |
51 | .UNINDENT | 51 | .UNINDENT |
Offset 311, 15 lines modified | Offset 311, 15 lines modified | ||
311 | .sp | 311 | .sp |
312 | New·in·version·1.2. | 312 | New·in·version·1.2. |
313 | .UNINDENT | 313 | .UNINDENT |
314 | .INDENT·0.0 | 314 | .INDENT·0.0 |
315 | .TP | 315 | .TP |
316 | .B·\-P | 316 | .B·\-P |
317 | (Useful·for·debugging·only.)··Run·the·Python·debugger,·\f | 317 | (Useful·for·debugging·only.)··Run·the·Python·debugger,·\fBpdb\fP,·if·an |
318 | unhandled·exception·occurs·while·building. | 318 | unhandled·exception·occurs·while·building. |
319 | .UNINDENT | 319 | .UNINDENT |
320 | .INDENT·0.0 | 320 | .INDENT·0.0 |
321 | .TP | 321 | .TP |
322 | .B·\-h,·\-\-help,·\-\-version | 322 | .B·\-h,·\-\-help,·\-\-version |
323 | Display·usage·summary·or·Sphinx·version. | 323 | Display·usage·summary·or·Sphinx·version. |
324 | .sp | 324 | .sp |