Skip to content

Migrate docs build to MkDocs #3426

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Migrate docs build to MkDocs #3426

wants to merge 1 commit into from
+3,123 −4,522

Conversation

@benoitc
Copy link
Owner

@benoitc benoitc commented Oct 6, 2025

Summary

  • replace legacy Sphinx site with MkDocs Material
  • move docs content into Markdown with refreshed landing page
  • add automation to build and deploy via MkDocs

Testing

  • mkdocs build

pajod
pajod reviewed Oct 9, 2025
View reviewed changes
docs/content/2019-news.md

19.10.0 / 2019/11/23
====================
!!! note
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed text here

pajod
pajod reviewed Oct 9, 2025
View reviewed changes
docs/content/reference/settings.md
Settings
========
This reference is built directly from `gunicorn.config.KNOWN_SETTINGS` and is
regenerated during every documentation build.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed text here.

@pajod
Copy link
Contributor

pajod commented Oct 9, 2025 •
edited
Loading 

--- a/site/2010-news.html
+++ b/site/2010-news/index.html

Looks like use_directory_urls=false is the correct choice here, because Cool URIs don't change

- -
+ —
  • Is this needed - I seem to be able to use ASCII hyphen-minus inside bullets points in Markdown just fine?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@pajod pajod pajod left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@benoitc @pajod