From f61d457df48e990afc75ab7f3c794bc6ecb10783 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Mon, 6 May 2024 17:39:13 -0600 Subject: [PATCH 1/2] Fix: sphinx warnings --- conf.py | 7 ++++++- .../repository-files/readme-file-best-practices.md | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/conf.py b/conf.py index 1020b9c0..45569b0c 100644 --- a/conf.py +++ b/conf.py @@ -29,7 +29,9 @@ # Get the latest Git tag - there might be a prettier way to do this but... try: release_value = ( - subprocess.check_output(["git", "describe", "--tags"]).decode("utf-8").strip() + subprocess.check_output(["git", "describe", "--tags"]) + .decode("utf-8") + .strip() ) release_value = release_value[:4] except subprocess.CalledProcessError: @@ -130,6 +132,9 @@ ".github", ".nox", "README.md", + "styles/write-good/README.md", + "styles/*", + ".pytest_cache/README.md", ] # For sitemap generation diff --git a/documentation/repository-files/readme-file-best-practices.md b/documentation/repository-files/readme-file-best-practices.md index 042f580d..e249284f 100644 --- a/documentation/repository-files/readme-file-best-practices.md +++ b/documentation/repository-files/readme-file-best-practices.md @@ -164,7 +164,7 @@ Finally be sure to include instructions on how to cite your package. Citation should include the DOI that you want used when citing your package, and any language that you'd like to see associated with the citation. -```{tip} README Resources +:::{admonition} README Resources :class: tip Below are some resources on creating great README.md files that you @@ -173,4 +173,4 @@ might find helpful. * [How to Write a Great README - Bane Sullivan](https://github.com/banesullivan/README) * [Art of README - Kira (@hackergrrl)](https://github.com/hackergrrl/art-of-readme) -``` +::: From d10b977e71d7ca9725f5bfcafdfe711da89148e8 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Mon, 6 May 2024 17:43:30 -0600 Subject: [PATCH 2/2] Fix: broken link --- tutorials/get-to-know-hatch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/get-to-know-hatch.md b/tutorials/get-to-know-hatch.md index 13bac1bf..b4ec6bb7 100644 --- a/tutorials/get-to-know-hatch.md +++ b/tutorials/get-to-know-hatch.md @@ -31,7 +31,7 @@ Note the version numbers will likely be different Once you have installed Hatch, you will want to customize the configuration. -Hatch stores your configuration information in a [`config.toml` file](https://.pypa.io/latest/config/project-templates/). +Hatch stores your configuration information in a [`config.toml` file](https://hatch.pypa.io/latest/config/project-templates/). While you can update the `config.toml` file through the command line, it might be easier to look at it and update it in a text editor if you are using it for the first time.