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] Use sphinxcontrib-mermaid instead of generating images from .mmd #41430

Closed
kou opened this issue Apr 29, 2024 · 1 comment
Closed

[Docs] Use sphinxcontrib-mermaid instead of generating images from .mmd #41430

kou opened this issue Apr 29, 2024 · 1 comment

Comments

@kou
Copy link
Member

kou commented Apr 29, 2024

Describe the enhancement requested

https://github.com/mgaitan/sphinxcontrib-mermaid

Component(s)

Documentation

kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue Apr 30, 2024
kou added a commit to kou/arrow that referenced this issue May 1, 2024
kou added a commit to kou/arrow that referenced this issue May 1, 2024
kou added a commit to kou/arrow that referenced this issue May 4, 2024
kou added a commit that referenced this issue May 8, 2024
…es from .mmd (#41455)

### Rationale for this change

This is for easy to maintain. 

### What changes are included in this PR?

* Install sphinxcontrib-mermaid
* Install Chromium to generate SVG from .mmd
* Use Debian instead of Ubuntu for building docs because Ubuntu provides Chromium only via snap
* Use a normal user not root to build documents because Mermaid require additional `--no-sandbox` argument when we use root

### Are these changes tested?

Yes.

### Are there any user-facing changes?

No.
* GitHub Issue: #41430

Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
@kou kou added this to the 17.0.0 milestone May 8, 2024
@kou
Copy link
Member Author

kou commented May 8, 2024

Issue resolved by pull request 41455
#41455

@kou kou closed this as completed May 8, 2024
vibhatha pushed a commit to vibhatha/arrow that referenced this issue May 25, 2024
…g images from .mmd (apache#41455)

### Rationale for this change

This is for easy to maintain. 

### What changes are included in this PR?

* Install sphinxcontrib-mermaid
* Install Chromium to generate SVG from .mmd
* Use Debian instead of Ubuntu for building docs because Ubuntu provides Chromium only via snap
* Use a normal user not root to build documents because Mermaid require additional `--no-sandbox` argument when we use root

### Are these changes tested?

Yes.

### Are there any user-facing changes?

No.
* GitHub Issue: apache#41430

Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant