sphinx-readme Logo
1.2.1

README

  • Sphinx README - Generate Beautiful README.rst for GitHub, PyPi, GitLab, BitBucket
    • About Sphinx README
    • 📋 Features
    • ⚙ Installation
    • 🔧 Configuration
  • Extension Configuration
    • Mandatory conf.py values
      • html_context
      • html_baseurl
      • readme_src_files
      • readme_docs_url_type
    • Optional conf.py values
      • readme_out_dir
      • readme_replace_attrs
      • readme_inline_markup
      • readme_raw_directive
      • readme_tags
      • readme_include_directive
      • readme_admonition_icons
      • readme_default_admonition_icon
      • readme_rubric_heading
      • readme_blob
      • linkcode_resolve
  • Sample conf.py

Documentation

  • The sphinx_readme package
    • The READMEParser Class
      • READMEParser
        • READMEParser.__init__()
        • READMEParser.config
        • READMEParser.ref_map
        • READMEParser.sources
        • READMEParser.toctrees
        • READMEParser.admonitions
        • READMEParser.rubrics
        • READMEParser.substitutions
        • READMEParser.titles
        • READMEParser.domains
        • READMEParser.roles
        • READMEParser.objtypes
        • READMEParser.intersphinx_pkgs
        • READMEParser.inventory
        • READMEParser.named_inventory
        • READMEParser.parse_env()
        • READMEParser.parse_titles()
        • READMEParser.parse_roles()
        • READMEParser.parse_objtypes()
        • READMEParser.parse_std_domain()
        • READMEParser.parse_py_domain()
        • READMEParser.get_py_target()
        • READMEParser.add_variants()
        • READMEParser.parse_doctree()
        • READMEParser.parse_admonitions()
        • READMEParser.parse_intersphinx_nodes()
        • READMEParser.parse_external_node()
        • READMEParser.parse_toctrees()
        • READMEParser.parse_rubrics()
        • READMEParser.get_external_ref()
        • READMEParser.get_external_id()
        • READMEParser.is_external_xref()
        • READMEParser.resolve()
        • READMEParser.replace_admonitions()
        • READMEParser.replace_toctrees()
        • READMEParser.replace_rst_images()
        • READMEParser.replace_rubrics()
        • READMEParser.replace_xrefs()
        • READMEParser.replace_py_xrefs()
        • READMEParser.replace_unresolved_xrefs()
        • READMEParser.get_xref_regex()
        • READMEParser.get_admonition_regex()
        • READMEParser.get_admonition_icon()
    • The READMEConfig Class
      • READMEConfig
        • READMEConfig.__init__()
        • READMEConfig.repo_blob
        • READMEConfig.repo_url
        • READMEConfig.blob_url
        • READMEConfig.docs_url
        • READMEConfig.get_repo_url()
        • READMEConfig.get_docs_url()
        • READMEConfig.setup_linkcode_resolve()
        • READMEConfig.read_rst()
        • READMEConfig.parse_include_directives()
        • READMEConfig.src_files
        • READMEConfig.sources
        • READMEConfig.out_dir
        • READMEConfig.docs_url_type
        • READMEConfig.repo_host
        • READMEConfig.image_baseurl
        • READMEConfig.icon_map
        • READMEConfig.admonition_template
    • The sphinx_readme.utils subpackage
      • The sphinx_readme.utils.git submodule
        • get_repo_url()
        • is_valid_username()
        • is_valid_repo()
        • get_blob_url()
        • get_repo_host()
        • get_blob()
        • get_head()
        • get_last_tag()
        • get_repo_dir()
      • The sphinx_readme.utils.linkcode submodule
        • get_linkcode_url()
        • get_linkcode_resolve()
      • The sphinx_readme.utils.rst submodule
        • escape_rst()
        • BEFORE_XREF
        • AFTER_XREF
        • format_hyperlink()
        • format_rst()
        • replace_only_directives()
        • remove_raw_directives()
        • replace_attrs()
        • replace_xrefs()
        • get_xref_variants()
        • get_all_xref_variants()
      • The sphinx_readme.utils.sphinx submodule
        • ExternalRef
        • set_conf_val()
        • get_conf_val()
      • The sphinx_readme.utils.docutils submodule
        • get_doctree()
        • parse_node_text()
sphinx-readme
  • The sphinx_readme package
  • The sphinx_readme.utils subpackage
  • Edit on GitHub
Previous Next

The sphinx_readme.utils subpackage

The sphinx_readme.utils subpackage contains a variety of helper functions

  • The sphinx_readme.utils.git submodule
  • The sphinx_readme.utils.linkcode submodule
  • The sphinx_readme.utils.rst submodule
  • The sphinx_readme.utils.sphinx submodule
  • The sphinx_readme.utils.docutils submodule
Previous Next

© Copyright 2023, Adam Korn.

Built with Sphinx using a theme provided by Read the Docs.