forked from Python-Markdown/markdown
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The API docs are auto-generated with mkdocstrings. The Google-style is used in docstrings to document parameters, return values, exceptions raised, etc.. Most of the docstrings throughout the codebase have been rewritten to be included in the documentations. Most objects have had type annotations added as well. While a significant portion of the code has received edits, there should be no changes to the code itself and therefore no changes in behavior. Co-authored-by @waylan who made most of the docstring edits.
- Loading branch information
Showing
72 changed files
with
1,980 additions
and
1,065 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -64,6 +64,7 @@ target/ | |
.python-version | ||
|
||
# virtualenv | ||
.venv/ | ||
venv/ | ||
ENV/ | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
/* Indentation. */ | ||
div.doc-contents:not(.first) { | ||
padding-left: 25px; | ||
} | ||
|
||
/* Mark external links as such. */ | ||
a.external::after, | ||
a.autorefs-external::after { | ||
/* https://primer.style/octicons/arrow-up-right-24 */ | ||
mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>'); | ||
-webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>'); | ||
content: ' '; | ||
|
||
display: inline-block; | ||
vertical-align: middle; | ||
position: relative; | ||
|
||
height: 1em; | ||
width: 1em; | ||
background-color: #005b81; | ||
} | ||
|
||
a.external:hover::after, | ||
a.autorefs-external:hover::after { | ||
background-color: #e32e00; | ||
} | ||
|
||
/* Customize custom links. */ | ||
a.autorefs code { | ||
background-color: #ecf0f3; | ||
font-weight: normal; | ||
color: #005B81; | ||
} | ||
|
||
a.autorefs:hover code { | ||
color: #E32E00; | ||
} | ||
|
||
/* Customize labels. */ | ||
.doc-label { | ||
border-radius: 15px; | ||
padding: 2px 8px; | ||
background-color: #f2f2f3; | ||
text-wrap: nowrap; | ||
} | ||
|
||
.doc-label code { | ||
color: #444; | ||
} | ||
|
||
.doc-label-deprecated { | ||
background-color: #ffe4e4; | ||
border: 1px solid #f66; | ||
} | ||
|
||
/* No shadows in any code. */ | ||
|
||
code { | ||
text-shadow: none; | ||
} | ||
|
||
/* Code spans in tables. */ | ||
|
||
table code { | ||
background-color: transparent !important; | ||
} | ||
|
||
/* Style source links */ | ||
a.doc-source-link { | ||
position: relative; | ||
float: right; | ||
border: 1px #005B81 solid; | ||
margin: 0 5px; | ||
padding: 0 5px; | ||
font-weight: normal; | ||
text-shadow: none; | ||
background-color: #f2f2f3; | ||
font-size: 1rem; | ||
} | ||
|
||
a.doc-source-link:hover { | ||
text-decoration: none; | ||
border-color: #E32E00; | ||
} | ||
|
||
/* Customize symbol names. */ | ||
code.doc-symbol-attribute::after { | ||
content: "Attr"; | ||
} | ||
|
||
code.doc-symbol-function::after { | ||
content: "Func"; | ||
} | ||
|
||
code.doc-symbol-method::after { | ||
content: "Method"; | ||
} | ||
|
||
code.doc-symbol-class::after { | ||
content: "Class"; | ||
} | ||
|
||
code.doc-symbol-module::after { | ||
content: "Module"; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
{% extends "_base/attribute.html" %} | ||
|
||
{% block heading scoped %} | ||
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ attribute.filepath }}#L{{ attribute.lineno }}{% if attribute.endlineno > attribute.lineno %}-L{{ attribute.endlineno }}{% endif %}" title='View source code on GitHub'>‹›</a> | ||
{%+ filter highlight(language="python", inline=True) %} | ||
{{ attribute_name }}{% if attribute.annotation %}: {{ attribute.annotation }}{% endif %} | ||
{% endfilter %} | ||
{% endblock heading %} | ||
|
||
{% block contents scoped %} | ||
{{ super() }} | ||
{% if attribute.value %} | ||
<p>Defined Value:</p> | ||
{%+ filter highlight(language="python", inline=False) %} | ||
{{ attribute.source }} | ||
{% endfilter %} | ||
{% endif %} | ||
{% endblock contents %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{% extends "_base/class.html" %} | ||
|
||
{% block heading scoped %} | ||
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ class.filepath }}#L{{ class.lineno }}" title="{{ config.source.title }}">‹›</a> | ||
{{ super() }} | ||
{% endblock heading %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{{ log.debug("Rendering admonition") }} | ||
<div class="admonition {{ section.value.kind }}"> | ||
<p class="admonition-title">{{ section.title|convert_markdown(heading_level, html_id, strip_paragraph=True) }}</p> | ||
{{ section.value.contents|convert_markdown(heading_level, html_id) }} | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{% extends "_base/function.html" %} | ||
|
||
{% block heading scoped %} | ||
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ function.filepath }}#L{{ function.lineno }}{% if function.endlineno > function.lineno %}-L{{ function.endlineno }}{% endif %}" title="{{ config.source.title }}">‹›</a> | ||
{{ super() }} | ||
{% endblock heading %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{% extends "_base/module.html" %} | ||
|
||
{% block heading scoped %} | ||
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ module.filepath }}" title="{{ config.source.title }}">‹›</a> | ||
{{ super() }} | ||
{% endblock heading %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.