Request for comments: Sphinx official docker image

[Komiya Takeshi]

Hi,

I have personal Docker image for Sphinx. I'd like to migrate this to official one.

https://github.com/tk0miya/sphinx-docker

Before that, I'd like to hear you the style of the image.

Q1. Is it useful for your project?

Q2. Is there any idea for the image? I'm not good at Docker. So any idea are welcome.

Q3. Would you like to add some tooling or package for this image?

Thanks,

Takeshi KOMIYA

[Kengo TODA]

HI,

Thanks for your great proposal! As an user of Sphinx & Docker, here I have several comments:

 

Q1. Is it useful for your project?

Yes.

In my project we maintain our Dockerfile by own, but we can replace it with official one simply.

So maintenance cost of our project will be reduced.

 

Q2. Is there any idea for the image? I'm not good at Docker. So any idea are welcome.

I think we don't need to have images just to switch command to exec.

I mean sphinx-base and sphinx-base-pdf are enough to have, then we can build pdf, html and epub easily.

Q3. Would you like to add some tooling or package for this image?

No request from my side. Thank you. 

[kritsadakorn kaewkham]

I don’t need, can you gets it all.

AS IS

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[Hor Meng Yoong]

Hi,

I would like to propose

1) A great text editor with side-by-side rst to pdf render. Visual Studio Code would be a great choice

2) Other non-English fonts

3) conf.py with most useful directive and settings but are commented out 

4) Sample sphinx projects using different themes

[Kengo TODA]

Hi Takeshi, is there any progress on this topic? Thanks in advance!

[Nicholas Bastin]

On Sat, Apr 18, 2020 at 3:45 AM Chris Mannix <c.r.m...@gmail.com> wrote:

Would you be open to removing the CMD directive from the end of each of the files? I'm trying to use the base images to run custom commands (context: Using in a GitHub Action for linting - https://github.com/cmannix/sphinx-action-example/pull/2/checks?check_run_id=597450414, https://github.com/ammaraskar/sphinx-action). The problem I have is that as a consumer of the image I don't necessarily want to run `make html` - I might have my own custom build command/options to run, and so this would be wasted effort.

Have you tried using the sphinx-base instead of sphinx-html?  I think this will give you what you want.

--

Nick

[Chris Mannix]

Hi Nick,

Thanks for your reply - apologies I deleted my original post in the group as I realised the issue wasn't as big a problem as I thought.

Do you mean https://github.com/sphinx-doc/docker/blob/master/base/Dockerfile ? That's the image I'm using, and it has the `CMD ["make", "html"] in it. Is there another source for these images?

Regards

Chris

On Saturday, 18 April 2020 09:43:00 UTC+1, Nicholas Bastin wrote:

[Nicholas Bastin]

On Sat, Apr 18, 2020 at 5:01 AM Chris Mannix <c.r.m...@gmail.com> wrote:

Do you mean https://github.com/sphinx-doc/docker/blob/master/base/Dockerfile ? That's the image I'm using, and it has the `CMD ["make", "html"] in it. Is there another source for these images?

Ah bugger, I'm still using the original links posted (https://github.com/tk0miya/sphinx-docker) and they were broken into a more sensible hierarchy (imo).

Also you have probably figured this out by now, but of course you can override CMD when you invoke your container.

--

Nick