diff options
| author |  Hassan Abouelela <[email protected]> | 2022-11-10 22:42:18 +0400 |
|---|---|---|
| committer | Hassan Abouelela <[email protected]> | 2022-11-10 22:42:18 +0400 |
| commit | a7e908a51d62021e4b8d49af73da605c2dfc73e7 (patch) | |
| tree | 6256b0d3f7302ac08638c2e576fa00629f76c79b | |
| parent | Add Support For Attributes In Docstrings (diff) | |
Clean Up Formatting Of Project Name In Docs
Signed-off-by: Hassan Abouelela <[email protected]>
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/utils.py | 10 |
2 files changed, 8 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index 9aaa8eff..2fea7264 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,7 +22,7 @@ from docs import utils # noqa: E402 # -- Project information ----------------------------------------------------- -project = "Bot Core" +project = "Pydis Core" copyright = "2021, Python Discord" author = "Python Discord" diff --git a/docs/utils.py b/docs/utils.py index ba6c8e34..3f58e767 100644 --- a/docs/utils.py +++ b/docs/utils.py @@ -160,9 +160,13 @@ def cleanup() -> None: content = file.read_text(encoding="utf-8").splitlines(keepends=True) # Rename the extension to be less wordy - # Example: pydis_core.exts -> pydis_core Exts - title = content[0].split()[0].strip().replace("pydis_core.", "").replace(".", " ").title() - title = f"{title}\n{'=' * len(title)}\n\n" + # Example: pydis_core.exts -> Exts + title = content[0].split()[0].strip().replace("\\", "").replace("pydis_core.", "").replace(".", " ") + if "pydis_core" in title: + # Root title: pydis_core -> pydis core + title = title.replace("_", " ") + + title = f"{title.title()}\n{'=' * len(title)}\n\n" content = title, *content[3:] file.write_text("".join(content), encoding="utf-8") |