From 82bd8ba5ff177347d094b095bd623a85aaa4c80f Mon Sep 17 00:00:00 2001 From: Sean Date: Wed, 18 May 2022 06:22:08 +0800 Subject: [PATCH] Clean up code style (#2825) * Change Github to GitHub * Add space before closing tag * Convert tabs to spaces * Fix coding style for some css --- docs/about/contributing.md | 4 +-- docs/dev-guide/themes.md | 4 +-- mkdocs/__main__.py | 6 ++-- mkdocs/themes/mkdocs/css/base.css | 2 +- mkdocs/themes/readthedocs/base.html | 4 +-- mkdocs/themes/readthedocs/css/theme_extra.css | 30 +++++++++---------- tox.ini | 6 ++-- 7 files changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/about/contributing.md b/docs/about/contributing.md index 670379cf..377a8d0b 100644 --- a/docs/about/contributing.md +++ b/docs/about/contributing.md @@ -61,7 +61,7 @@ root of your MkDocs repository. It will attempt to run the tests against all of the Python versions we support. So don't be concerned if you are missing some and they fail. The rest -will be verified by [Github Actions] when you submit a pull request. +will be verified by [GitHub Actions] when you submit a pull request. ## Translating themes @@ -107,7 +107,7 @@ Themes] for details. [virtualenv]: https://virtualenv.pypa.io/en/latest/user_guide.html [pip]: https://pip.pypa.io/en/stable/ [tox]: https://tox.readthedocs.io/en/latest/ -[Github Actions]: https://docs.github.com/actions +[GitHub Actions]: https://docs.github.com/actions [PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/ [Translating Themes]: ../dev-guide/translations.md [Jinja's i18n extension]: https://jinja.palletsprojects.com/en/latest/extensions/#i18n-extension diff --git a/docs/dev-guide/themes.md b/docs/dev-guide/themes.md index 5f21b430..178a6f3e 100644 --- a/docs/dev-guide/themes.md +++ b/docs/dev-guide/themes.md @@ -229,14 +229,14 @@ navigation as a nested list.
  • {{ nav_item.title }}
    • {% else %} -
  • +
  • {{ nav_item.title }}
    • {% endif %} diff --git a/mkdocs/__main__.py b/mkdocs/__main__.py index bcbff4f2..1067996f 100644 --- a/mkdocs/__main__.py +++ b/mkdocs/__main__.py @@ -88,10 +88,10 @@ reload_help = "Enable the live reloading in the development server (this is the no_reload_help = "Disable the live reloading in the development server." dirty_reload_help = "Enable the live reloading in the development server, but only re-build files that have changed" commit_message_help = ("A commit message to use when committing to the " - "Github Pages remote branch. Commit {sha} and MkDocs {version} are available as expansions") -remote_branch_help = ("The remote branch to commit to for Github Pages. This " + "GitHub Pages remote branch. Commit {sha} and MkDocs {version} are available as expansions") +remote_branch_help = ("The remote branch to commit to for GitHub Pages. This " "overrides the value specified in config") -remote_name_help = ("The remote name to commit to for Github Pages. This " +remote_name_help = ("The remote name to commit to for GitHub Pages. This " "overrides the value specified in config") force_help = "Force the push to the repository." no_history_help = "Replace the whole Git history with one new commit." diff --git a/mkdocs/themes/mkdocs/css/base.css b/mkdocs/themes/mkdocs/css/base.css index 13f6c918..25e17a63 100644 --- a/mkdocs/themes/mkdocs/css/base.css +++ b/mkdocs/themes/mkdocs/css/base.css @@ -209,7 +209,7 @@ footer { padding-left: .5em; } -h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .headerlink, h5:hover .headerlink, h6:hover .headerlink{ +h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .headerlink, h5:hover .headerlink, h6:hover .headerlink { display:inline-block; } diff --git a/mkdocs/themes/readthedocs/base.html b/mkdocs/themes/readthedocs/base.html index e7dd8762..7683e706 100644 --- a/mkdocs/themes/readthedocs/base.html +++ b/mkdocs/themes/readthedocs/base.html @@ -103,9 +103,9 @@ {{ config.extra.version }} {%- endif %} - {%- block search_button %} + {%- block search_button %} {%- if 'search' in config['plugins'] %}{%- include "searchbox.html" %}{%- endif %} - {%- endblock %} + {%- endblock %}