Skip to content

Commit 1b6ab14

Browse files
authored
Fix /changelog/ and /contributing/ docs URLs (#1541)
* Fix `/changelog/` and `/contributing/` docs URLs PR #1474 moved the docs to the `docs/` directory, and also changed casing of some filenames. - `docs/changelog.md` -> `docs/CHANGELOG.md` - `docs/contributing.md` -> `docs/CONTRIBUTING.md` This changed URL path parameters as well. URL paths to these pages must now be uppercased when accessing the deployed docs (#1540). For example, navigating to https://pipx.pypa.io/stable/CONTRIBUTING/ shows the correct page, but navigating to https://pipx.pypa.io/stable/contributing/ displays a (poorly styled) `404` page. This commit will move the pages back to `docs/changelog.md` and `docs/contributing.md` to restore the previous URLs to these pages. Note that the casing changes to not affect the homepage because MkDocs automatically handles `README.md` as `index.md`. https://www.mkdocs.org/user-guide/writing-your-docs/#index-pages * Categorize Towncrier changelog fragment as `doc` #1541 (comment)
1 parent 9f49ec9 commit 1b6ab14

File tree

5 files changed

+4
-3
lines changed

5 files changed

+4
-3
lines changed

changelog.d/1540.doc.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix `/changelog/` and `/contributing/` docs URLs
File renamed without changes.
File renamed without changes.

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ nav:
3535
- Comparison to Other Tools: "comparisons.md"
3636
- How pipx works: "how-pipx-works.md"
3737
- Programs to Try: "programs-to-try.md"
38-
- Contributing: "CONTRIBUTING.md"
39-
- Changelog: "CHANGELOG.md"
38+
- Contributing: "contributing.md"
39+
- Changelog: "changelog.md"
4040

4141
markdown_extensions:
4242
- markdown_gfm_admonition # GitHub's admonition (alert) syntax

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ addopts = [ "-ra", "--strict-config", "--strict-markers" ]
111111

112112
[tool.towncrier]
113113
directory = "changelog.d"
114-
filename = "docs/CHANGELOG.md"
114+
filename = "docs/changelog.md"
115115
start_string = "<!-- towncrier release notes start -->\n"
116116
underlines = [
117117
"",

0 commit comments

Comments
 (0)