Skip to content

Fix: sphinx warnings #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -130,6 +132,9 @@
".github",
".nox",
"README.md",
"styles/write-good/README.md",
"styles/*",
".pytest_cache/README.md",
]

# For sitemap generation
Expand Down
4 changes: 2 additions & 2 deletions documentation/repository-files/readme-file-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

```
:::
2 changes: 1 addition & 1 deletion tutorials/get-to-know-hatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading