Skip to content
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

docs, mkdocs: fix domain, title caps #15

Merged
merged 3 commits into from
Jul 2, 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: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,10 @@ edit documents.

Once it has started, navigate to [http://localhost:10000](http://localhost:10000)
in your browser! Any edits made will render as you save your work.

### Adding new pages

To add a new page, you'll need to do two things:

1. Create the page itself in the appropriate location under [`./docs`](./docs/).
2. Add the page to the `nav` hierarchy in [`mkdocs.yml`](./mkdocs.yml).
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
source: https://pypi.org/policy/terms-of-use/
---
# Terms of use
# Terms of Use

By registering to upload materials to PyPI, I agree and affirmatively
acknowledge the following:
Expand Down
25 changes: 24 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site_name: Python Software Foundation Policies
preview: !ENV [PREVIEW, 'False']
preview: !ENV [PREVIEW, "False"]
theme:
name: material
custom_dir: ./overrides
Expand All @@ -25,3 +25,26 @@ extra:
homepage: https://python.org/psf/
site_url: https://policies.python.org/
repo_url: https://github.com/psf/policies

nav:
- "pypi.org":
- "pypi.org/Acceptable-Use-Policy.md"
- "pypi.org/Code-of-Conduct.md"
- "pypi.org/Terms-of-Use.md"
- "python.org":
- "python.org/CVE-Numbering-Authority.md"
- "python.org/Contributing.md"
- "python.org/Copyright-Policy.md"
- "python.org/Legal-Statements.md"
- "python.org/Privacy-Policy.md"
- "Code of Conduct":
- "python.org/code-of-conduct/index.md"
- "python.org/code-of-conduct/Best-Practices.md"
- "python.org/code-of-conduct/Enforcement-Procedures.md"
- "python.org/code-of-conduct/Procedures-for-Reporting-Incidents.md"
- "us.pycon.org":
- "us.pycon.org/Privacy-Policy.md"
- "Code of Conduct":
- "us.pycon.org/code-of-conduct/index.md"
- "us.pycon.org/code-of-conduct/Enforcement-Procedures.md"
- "us.pycon.org/code-of-conduct/Procedures-for-Reporting-Incidents.md"