Skip to content

Add Sphinx setup and virtualenv for documentation build support - #414

Merged
RCheesley merged 9 commits into
mautic:5.2from
shinde-rahul:ddev-sphinx
Sep 3, 2025
Merged

Add Sphinx setup and virtualenv for documentation build support#414
RCheesley merged 9 commits into
mautic:5.2from
shinde-rahul:ddev-sphinx

Conversation

@shinde-rahul

@shinde-rahul shinde-rahul commented Jul 27, 2025

Copy link
Copy Markdown
Contributor

This adds a DDEV configuration that has

  • sphinx and required dependencies.
  • a post-start hook that builds the documentation

After editing, you can ddev build-docs to update the html and view in a browser.

@shinde-rahul
shinde-rahul marked this pull request as ready for review July 27, 2025 12:08

@rfay rfay left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I didn't manually test, but this strategy seems fine.

@shinde-rahul shinde-rahul changed the title Add sphinx and build capabilities Add Sphinx setup and virtualenv for documentation build support Jul 27, 2025
@shinde-rahul shinde-rahul reopened this Jul 27, 2025
Comment thread README.md Outdated
Comment thread .ddev/commands/web/build-docs Outdated
adiati98
adiati98 previously approved these changes Jul 28, 2025

@adiati98 adiati98 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've tested this locally and it worked!!! 🚀

Thanks so much, @shinde-rahul! ✨

outstanding GIF

@RCheesley
RCheesley merged commit 25e328e into mautic:5.2 Sep 3, 2025
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants