Re: Sphinx Workshop - translate and learn

7 views
Skip to first unread message

gilberto dos santos alves

unread,
Nov 16, 2016, 9:53:49 AM11/16/16
to sphin...@googlegroups.com
Hi Konstantin!
I agree with you, but my suggestion for you is start to translate sphinx-doc using transifex.com and there you will find very usefull references, url for infra-structure used by sphinx like docutils, rstStrucutredText, gettext and others python resources.

regards from pt_BR translations at readthedocs.


--
gilberto dos santos alves
+55(11)9-8646-5049
sao paulo - sp - brasil





2016-11-15 19:30 GMT-02:00 Konstantin Molchanov <moig...@gmail.com>:
Hi!

TL;DR: Let's organize an online workshop for wannabe Sphinx extension developers. See the long version below.

I find Sphinx a very complex piece of software, difficult to hack for a newcomer. Given most techwriters are not professional programmers but rather hobbyists, it's extra hard for them to create new extensions for Sphinx.

To make things worse, there is a clear shortage of tutorials on extension development for Sphinx. There is one official one (http://www.sphinx-doc.org/en/master/extdev/tutorial.html) and one by Eric Holscher (http://ericholscher.com/blog/2016/jul/25/integrating-jinja-rst-sphinx/).

Take me for example. I am a techwriter and a hobbyist Python developer. I desperately want to learn Sphinx's internals and develop extensions on a regular basis. But due to lack of learning materials, I give up time after time. I am sure there are others who suffer like me—wanting to give back to the community, but not able to.

I see it as a major problem with Sphinx. We need more great extensions for more tasks to make Sphinx more universal and widely used.

How about we organize an online workshop about Sphinx extension development? Let the experts teach on real-life examples, with real time feedback. I know I would participate, and I know a couple of people who probably would too.

If you find the idea worth discussing, let's discuss! Feel free to share you pros and cons, suggestions and considerations.

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

Reply all
Reply to author
Forward
0 new messages