Browse Source

Merge pull request #218 from Learnware-LAMDA/rel1

[DOC, FIX] update badge, update autodoc config, fix no logo in doc bug
tags/v0.3.2
bxdd GitHub 1 year ago
parent
commit
2c7b1f0ae6
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 2 deletions
  1. +1
    -1
      README_zh.md
  2. +5
    -1
      docs/conf.py

+ 1
- 1
README_zh.md View File

@@ -9,7 +9,7 @@
<img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/learnware.svg?logo=python&logoColor=white"> <img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/learnware.svg?logo=python&logoColor=white">
</a> </a>
<a href="https://pypi.org/project/learnware/#files"> <a href="https://pypi.org/project/learnware/#files">
<img alt="Platform" src="https://img.shields.io/badge/platform-linux%20%7C%20windows%20%7C%20macos-lightgrey">
<img alt="Platform" src="https://img.shields.io/badge/platform-linux%20%7C%20windows-lightgrey">
</a> </a>
<a href="https://pypi.org/project/learnware/#history"> <a href="https://pypi.org/project/learnware/#history">
<img alt="PypI Versions" src="https://img.shields.io/pypi/v/learnware"> <img alt="PypI Versions" src="https://img.shields.io/pypi/v/learnware">


+ 5
- 1
docs/conf.py View File

@@ -96,7 +96,7 @@ html_theme_options = {
# "display_version": False, # "display_version": False,
"navigation_depth": 4, "navigation_depth": 4,
} }
html_logo = "_static/img/logo/logo1.png"
html_logo = "_static/img/logo/logo.svg"




# These folders are copied to the documentation's HTML output # These folders are copied to the documentation's HTML output
@@ -118,6 +118,10 @@ autodoc_member_order = "bysource"
autodoc_default_flags = ["members"] autodoc_default_flags = ["members"]
autodoc_default_options = { autodoc_default_options = {
"members": True, "members": True,
'private-members': True,
'special-members': True,
'undoc-members': True,
'show-inheritance': True,
"member-order": "bysource", "member-order": "bysource",
"special-members": "__init__", "special-members": "__init__",
} }

Loading…
Cancel
Save