Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 5c30ac3

Browse filesBrowse files
ambvambv
authored
Fix reference targets in Sphinx documentation (html5lib#562)
Fixes html5lib#548
1 parent ff7fa37 commit 5c30ac3
Copy full SHA for 5c30ac3

8 files changed

+61
-51
lines changed

‎doc/conf.py

Copy file name to clipboardExpand all lines: doc/conf.py
+9-1Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919

2020
# Add any Sphinx extension module names here, as strings. They can be extensions
2121
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
22-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode']
22+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode',
23+
'sphinx.ext.intersphinx']
2324

2425
# Add any paths that contain templates here, relative to this directory.
2526
templates_path = ['_templates']
@@ -92,6 +93,13 @@
9293
]
9394

9495

96+
intersphinx_mapping = {
97+
'python': ('https://docs.python.org/3/', None),
98+
'lxml': ('https://lxml.de/apidoc/', None),
99+
'chardet': ('https://chardet.readthedocs.io/en/latest/', None),
100+
}
101+
102+
95103
class CExtMock(object):
96104
"""Required for autodoc on readthedocs.org where you cannot build C extensions."""
97105
def __init__(self, *args, **kwargs):

‎doc/html5lib.filters.rst

Copy file name to clipboardExpand all lines: doc/html5lib.filters.rst
+19-14Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,61 @@
11
filters Package
22
===============
33

4-
:mod:`base` Module
5-
-------------------
4+
``base`` Module
5+
----------------
66

77
.. automodule:: html5lib.filters.base
88
:members:
99
:show-inheritance:
1010
:special-members: __init__
1111

12-
:mod:`alphabeticalattributes` Module
13-
------------------------------------
12+
.. autoclass:: html5lib.filters.base.Filter
13+
:members:
14+
:show-inheritance:
15+
:special-members: __init__
16+
17+
``alphabeticalattributes`` Module
18+
---------------------------------
1419

1520
.. automodule:: html5lib.filters.alphabeticalattributes
1621
:members:
1722
:show-inheritance:
1823
:special-members: __init__
1924

20-
:mod:`inject_meta_charset` Module
21-
---------------------------------
25+
``inject_meta_charset`` Module
26+
------------------------------
2227

2328
.. automodule:: html5lib.filters.inject_meta_charset
2429
:members:
2530
:show-inheritance:
2631
:special-members: __init__
2732

28-
:mod:`lint` Module
29-
------------------
33+
``lint`` Module
34+
---------------
3035

3136
.. automodule:: html5lib.filters.lint
3237
:members:
3338
:show-inheritance:
3439
:special-members: __init__
3540

36-
:mod:`optionaltags` Module
37-
--------------------------
41+
``optionaltags`` Module
42+
-----------------------
3843

3944
.. automodule:: html5lib.filters.optionaltags
4045
:members:
4146
:show-inheritance:
4247
:special-members: __init__
4348

44-
:mod:`sanitizer` Module
45-
-----------------------
49+
``sanitizer`` Module
50+
--------------------
4651

4752
.. automodule:: html5lib.filters.sanitizer
4853
:members:
4954
:show-inheritance:
5055
:special-members: __init__
5156

52-
:mod:`whitespace` Module
53-
------------------------
57+
``whitespace`` Module
58+
---------------------
5459

5560
.. automodule:: html5lib.filters.whitespace
5661
:members:

‎doc/html5lib.rst

Copy file name to clipboardExpand all lines: doc/html5lib.rst
+11-6Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,34 @@ html5lib Package
44
.. automodule:: html5lib
55
:members: __version__
66

7-
:mod:`constants` Module
8-
-----------------------
7+
``constants`` Module
8+
--------------------
99

1010
.. automodule:: html5lib.constants
1111
:members:
1212
:show-inheritance:
1313

14-
:mod:`html5parser` Module
15-
-------------------------
14+
``html5parser`` Module
15+
----------------------
1616

1717
.. automodule:: html5lib.html5parser
1818
:members:
1919
:show-inheritance:
2020
:special-members: __init__
2121

22-
:mod:`serializer` Module
23-
------------------------
22+
``serializer`` Module
23+
---------------------
2424

2525
.. automodule:: html5lib.serializer
2626
:members:
2727
:show-inheritance:
2828
:special-members: __init__
2929

30+
.. autoclass:: html5lib.serializer.HTMLSerializer
31+
:members:
32+
:show-inheritance:
33+
:special-members: __init__
34+
3035
Subpackages
3136
-----------
3237

‎doc/html5lib.treeadapters.rst

Copy file name to clipboardExpand all lines: doc/html5lib.treeadapters.rst
-3Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
treeadapters Package
22
====================
33

4-
:mod:`~html5lib.treeadapters` Package
5-
-------------------------------------
6-
74
.. automodule:: html5lib.treeadapters
85
:members:
96
:show-inheritance:

‎doc/html5lib.treebuilders.rst

Copy file name to clipboardExpand all lines: doc/html5lib.treebuilders.rst
+8-11Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,37 @@
11
treebuilders Package
22
====================
33

4-
:mod:`treebuilders` Package
5-
---------------------------
6-
74
.. automodule:: html5lib.treebuilders
85
:members:
96
:show-inheritance:
107
:special-members: __init__
118

12-
:mod:`base` Module
13-
-------------------
9+
``base`` Module
10+
---------------
1411

1512
.. automodule:: html5lib.treebuilders.base
1613
:members:
1714
:show-inheritance:
1815
:special-members: __init__
1916

20-
:mod:`dom` Module
21-
-----------------
17+
``dom`` Module
18+
--------------
2219

2320
.. automodule:: html5lib.treebuilders.dom
2421
:members:
2522
:show-inheritance:
2623
:special-members: __init__
2724

28-
:mod:`etree` Module
29-
-------------------
25+
``etree`` Module
26+
----------------
3027

3128
.. automodule:: html5lib.treebuilders.etree
3229
:members:
3330
:show-inheritance:
3431
:special-members: __init__
3532

36-
:mod:`etree_lxml` Module
37-
------------------------
33+
``etree_lxml`` Module
34+
---------------------
3835

3936
.. automodule:: html5lib.treebuilders.etree_lxml
4037
:members:

‎doc/html5lib.treewalkers.rst

Copy file name to clipboardExpand all lines: doc/html5lib.treewalkers.rst
+10-13Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,45 @@
11
treewalkers Package
22
===================
33

4-
:mod:`treewalkers` Package
5-
--------------------------
6-
74
.. automodule:: html5lib.treewalkers
85
:members:
96
:show-inheritance:
107
:special-members: __init__
118

12-
:mod:`base` Module
13-
------------------
9+
``base`` Module
10+
---------------
1411

1512
.. automodule:: html5lib.treewalkers.base
1613
:members:
1714
:show-inheritance:
1815
:special-members: __init__
1916

20-
:mod:`dom` Module
21-
-----------------
17+
``dom`` Module
18+
--------------
2219

2320
.. automodule:: html5lib.treewalkers.dom
2421
:members:
2522
:show-inheritance:
2623
:special-members: __init__
2724

28-
:mod:`etree` Module
29-
-------------------
25+
``etree`` Module
26+
----------------
3027

3128
.. automodule:: html5lib.treewalkers.etree
3229
:members:
3330
:show-inheritance:
3431
:special-members: __init__
3532

36-
:mod:`etree_lxml` Module
37-
------------------------
33+
``etree_lxml`` Module
34+
---------------------
3835

3936
.. automodule:: html5lib.treewalkers.etree_lxml
4037
:members:
4138
:show-inheritance:
4239
:special-members: __init__
4340

44-
:mod:`genshi` Module
45-
--------------------
41+
``genshi`` Module
42+
-----------------
4643

4744
.. automodule:: html5lib.treewalkers.genshi
4845
:members:

‎doc/movingparts.rst

Copy file name to clipboardExpand all lines: doc/movingparts.rst
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Tree builders
1515
The parser reads HTML by tokenizing the content and building a tree that
1616
the user can later access. html5lib can build three types of trees:
1717

18-
* ``etree`` - this is the default; builds a tree based on :mod:`xml.etree`,
19-
which can be found in the standard library. Whenever possible, the
20-
accelerated ``ElementTree`` implementation (i.e.
18+
* ``etree`` - this is the default; builds a tree based on
19+
:mod:`xml.etree.ElementTree`, which can be found in the standard library.
20+
Whenever possible, the accelerated ``ElementTree`` implementation (i.e.
2121
``xml.etree.cElementTree`` on Python 2.x) is used.
2222

2323
* ``dom`` - builds a tree based on :mod:`xml.dom.minidom`.

‎html5lib/treebuilders/base.py

Copy file name to clipboardExpand all lines: html5lib/treebuilders/base.py
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ def hasContent(self):
121121

122122
class ActiveFormattingElements(list):
123123
def append(self, node):
124+
"""Append node to the end of the list."""
124125
equalCount = 0
125126
if node != Marker:
126127
for element in self[::-1]:

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.