Moved documentation to docs directory (#1474)

* Fixed broken link in README.md * Moved all documentation to docs directory * Rolled back first try to repair broken link * added changelog entry * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
pypa · Jul 18, 2024 · 832c3fa · 832c3fa
1 parent 3c53896
commit 832c3fa
Show file tree

Hide file tree

Showing 10 changed files with 6 additions and 9 deletions.
diff --git a/changelog.d/1479.doc.md b/changelog.d/1479.doc.md
@@ -0,0 +1 @@
+Move all documentation files to the `docs` directory.
diff --git a/CHANGELOG.md → docs/CHANGELOG.md b/CHANGELOG.md → docs/CHANGELOG.md
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
diff --git a/README.md → docs/README.md b/README.md → docs/README.md
diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/installation.md b/installation.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -26,7 +26,7 @@ extra:
 
 
 nav:
-  - Home: "index.md"
+  - Home: "README.md"
   - Installation: "installation.md"
   - Getting Started: "getting-started.md"
   - Docs: "docs.md"
@@ -35,8 +35,8 @@ nav:
   - Comparison to Other Tools: "comparisons.md"
   - How pipx works: "how-pipx-works.md"
   - Programs to Try: "programs-to-try.md"
-  - Contributing: "contributing.md"
-  - Changelog: "changelog.md"
+  - Contributing: "CONTRIBUTING.md"
+  - Changelog: "CHANGELOG.md"
 
 markdown_extensions:
   - markdown_gfm_admonition  # GitHub's admonition (alert) syntax

diff --git a/pyproject.toml b/pyproject.toml
@@ -8,7 +8,7 @@ requires = [
 [project]
 name = "pipx"
 description = "Install and Run Python Applications in Isolated Environments"
-readme = "README.md"
+readme = "docs/README.md"
 keywords = [
   "cli",
   "install",
@@ -107,7 +107,7 @@ markers = [
 
 [tool.towncrier]
 directory = "changelog.d"
-filename = "CHANGELOG.md"
+filename = "docs/CHANGELOG.md"
 start_string = "<!-- towncrier release notes start -->\n"
 underlines = [
   "",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Move all documentation files to the `docs` directory.