Skip to content

Commit 5c3c8a6

Browse files
authored
Fix: sphinx warnings (#246)
* Fix: sphinx warnings * Fix: broken link
1 parent accd901 commit 5c3c8a6

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

conf.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@
2929
# Get the latest Git tag - there might be a prettier way to do this but...
3030
try:
3131
release_value = (
32-
subprocess.check_output(["git", "describe", "--tags"]).decode("utf-8").strip()
32+
subprocess.check_output(["git", "describe", "--tags"])
33+
.decode("utf-8")
34+
.strip()
3335
)
3436
release_value = release_value[:4]
3537
except subprocess.CalledProcessError:
@@ -130,6 +132,9 @@
130132
".github",
131133
".nox",
132134
"README.md",
135+
"styles/write-good/README.md",
136+
"styles/*",
137+
".pytest_cache/README.md",
133138
]
134139

135140
# For sitemap generation

documentation/repository-files/readme-file-best-practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Finally be sure to include instructions on how to cite your package.
164164
Citation should include the DOI that you want used when citing your package,
165165
and any language that you'd like to see associated with the citation.
166166

167-
```{tip} README Resources
167+
:::{admonition} README Resources
168168
:class: tip
169169

170170
Below are some resources on creating great README.md files that you
@@ -173,4 +173,4 @@ might find helpful.
173173
* [How to Write a Great README - Bane Sullivan](https://github.com/banesullivan/README)
174174
* [Art of README - Kira (@hackergrrl)](https://github.com/hackergrrl/art-of-readme)
175175

176-
```
176+
:::

tutorials/get-to-know-hatch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Note the version numbers will likely be different
3131

3232
Once you have installed Hatch, you will want to customize the configuration.
3333

34-
Hatch stores your configuration information in a [`config.toml` file](https://.pypa.io/latest/config/project-templates/).
34+
Hatch stores your configuration information in a [`config.toml` file](https://hatch.pypa.io/latest/config/project-templates/).
3535

3636
While you can update the `config.toml` file through the command line,
3737
it might be easier to look at it and update it in a text editor if you are using it for the first time.

0 commit comments

Comments
 (0)