Index

_

__init__() (sphinx_readme.config.READMEConfig method) (sphinx_readme.parser.READMEParser method) (sphinx_readme.utils.sphinx.ExternalRef method)

A

add_variants() (sphinx_readme.parser.READMEParser method) admonition_template (sphinx_readme.config.READMEConfig property)

admonitions (sphinx_readme.parser.READMEParser attribute) AFTER_XREF (in module sphinx_readme.utils.rst)

B

BEFORE_XREF (in module sphinx_readme.utils.rst)

blob_url (sphinx_readme.config.READMEConfig attribute)

C

config (sphinx_readme.parser.READMEParser attribute) configuration value html_baseurl html_context linkcode_resolve readme_admonition_icons readme_blob readme_default_admonition_icon readme_docs_url_type readme_include_directive readme_inline_markup readme_out_dir readme_raw_directive readme_replace_attrs readme_rubric_heading readme_src_files readme_tags

D

docs_url (sphinx_readme.config.READMEConfig attribute)

docs_url_type (sphinx_readme.config.READMEConfig property) domains (sphinx_readme.parser.READMEParser attribute)

E

escape_rst() (in module sphinx_readme.utils.rst)

ExternalRef (class in sphinx_readme.utils.sphinx)

F

format_hyperlink() (in module sphinx_readme.utils.rst)

format_rst() (in module sphinx_readme.utils.rst)

G

get_admonition_icon() (sphinx_readme.parser.READMEParser method) get_admonition_regex() (sphinx_readme.parser.READMEParser method) get_all_xref_variants() (in module sphinx_readme.utils.rst) get_blob() (in module sphinx_readme.utils.git) get_blob_url() (in module sphinx_readme.utils.git) get_conf_val() (in module sphinx_readme.utils.sphinx) get_docs_url() (sphinx_readme.config.READMEConfig method) get_doctree() (in module sphinx_readme.utils.docutils) get_external_id() (sphinx_readme.parser.READMEParser method) get_external_ref() (sphinx_readme.parser.READMEParser method)

get_head() (in module sphinx_readme.utils.git) get_last_tag() (in module sphinx_readme.utils.git) get_linkcode_resolve() (in module sphinx_readme.utils.linkcode) get_linkcode_url() (in module sphinx_readme.utils.linkcode) get_py_target() (sphinx_readme.parser.READMEParser method) get_repo_dir() (in module sphinx_readme.utils.git) get_repo_host() (in module sphinx_readme.utils.git) get_repo_url() (in module sphinx_readme.utils.git) (sphinx_readme.config.READMEConfig method) get_xref_regex() (sphinx_readme.parser.READMEParser method) get_xref_variants() (in module sphinx_readme.utils.rst)

H

html_baseurl configuration value

html_context configuration value

I

icon_map (sphinx_readme.config.READMEConfig property) id (sphinx_readme.utils.sphinx.ExternalRef property) image_baseurl (sphinx_readme.config.READMEConfig property) intersphinx_pkgs (sphinx_readme.parser.READMEParser attribute)

inventory (sphinx_readme.parser.READMEParser attribute) is_external_xref() (sphinx_readme.parser.READMEParser method) is_valid_repo() (in module sphinx_readme.utils.git) is_valid_username() (in module sphinx_readme.utils.git)

L

label (sphinx_readme.utils.sphinx.ExternalRef property)

linkcode_resolve configuration value

M

module sphinx_readme.__init__ sphinx_readme.config sphinx_readme.parser sphinx_readme.utils sphinx_readme.utils.docutils sphinx_readme.utils.git sphinx_readme.utils.linkcode sphinx_readme.utils.rst sphinx_readme.utils.sphinx

N

named_inventory (sphinx_readme.parser.READMEParser attribute)

O

objtypes (sphinx_readme.parser.READMEParser attribute)

out_dir (sphinx_readme.config.READMEConfig property)

P

parse_admonitions() (sphinx_readme.parser.READMEParser method) parse_doctree() (sphinx_readme.parser.READMEParser method) parse_env() (sphinx_readme.parser.READMEParser method) parse_external_node() (sphinx_readme.parser.READMEParser method) parse_include_directives() (sphinx_readme.config.READMEConfig method) parse_intersphinx_nodes() (sphinx_readme.parser.READMEParser method) parse_node_text() (in module sphinx_readme.utils.docutils)

parse_objtypes() (sphinx_readme.parser.READMEParser method) parse_py_domain() (sphinx_readme.parser.READMEParser method) parse_roles() (sphinx_readme.parser.READMEParser method) parse_rubrics() (sphinx_readme.parser.READMEParser method) parse_std_domain() (sphinx_readme.parser.READMEParser method) parse_titles() (sphinx_readme.parser.READMEParser method) parse_toctrees() (sphinx_readme.parser.READMEParser method)

R

read_rst() (sphinx_readme.config.READMEConfig method) readme_admonition_icons configuration value readme_blob configuration value readme_default_admonition_icon configuration value readme_docs_url_type configuration value readme_include_directive configuration value readme_inline_markup configuration value readme_out_dir configuration value readme_raw_directive configuration value readme_replace_attrs configuration value readme_rubric_heading configuration value readme_src_files configuration value

readme_tags configuration value READMEConfig (class in sphinx_readme.config) READMEParser (class in sphinx_readme.parser) ref_map (sphinx_readme.parser.READMEParser attribute) remove_raw_directives() (in module sphinx_readme.utils.rst) replace_admonitions() (sphinx_readme.parser.READMEParser method) replace_attrs() (in module sphinx_readme.utils.rst) replace_only_directives() (in module sphinx_readme.utils.rst) replace_py_xrefs() (sphinx_readme.parser.READMEParser method) replace_rst_images() (sphinx_readme.parser.READMEParser method) replace_rubrics() (sphinx_readme.parser.READMEParser method) replace_toctrees() (sphinx_readme.parser.READMEParser method) replace_unresolved_xrefs() (sphinx_readme.parser.READMEParser method) replace_xrefs() (in module sphinx_readme.utils.rst) (sphinx_readme.parser.READMEParser method) repo_blob (sphinx_readme.config.READMEConfig attribute) repo_host (sphinx_readme.config.READMEConfig property) repo_url (sphinx_readme.config.READMEConfig attribute) resolve() (sphinx_readme.parser.READMEParser method) roles (sphinx_readme.parser.READMEParser attribute) rubrics (sphinx_readme.parser.READMEParser attribute)

S

set_conf_val() (in module sphinx_readme.utils.sphinx) setup_linkcode_resolve() (sphinx_readme.config.READMEConfig method) sources (sphinx_readme.config.READMEConfig property) (sphinx_readme.parser.READMEParser attribute) sphinx_readme.__init__ module sphinx_readme.config module sphinx_readme.parser module sphinx_readme.utils module

sphinx_readme.utils.docutils module sphinx_readme.utils.git module sphinx_readme.utils.linkcode module sphinx_readme.utils.rst module sphinx_readme.utils.sphinx module src_files (sphinx_readme.config.READMEConfig property) substitutions (sphinx_readme.parser.READMEParser attribute)

T

titles (sphinx_readme.parser.READMEParser attribute)

toctrees (sphinx_readme.parser.READMEParser attribute)