Skip to main content

Ralsina.Me — Roberto Alsina's website

Nikola is now more compatible with Sphinx

Some­times, you need to use the same text in more than one place. For ex­am­ple, you may want to use frag­ments of your soft­ware man­u­als in your soft­ware's site.

If you are part of the Python-­verse then it's like­ly that your docs are writ­ten us­ing Sphinx. Ǹiko­la and Sphinx share roots in re­Struc­tured­Text so they are al­ready com­pat­i­ble in many im­por­tant ways.

How­ev­er, Sphinx adds a whole bunch of ex­ten­sions to re­Struc­tured­Text and Sphinx users use them. So, what's a dev to do? He'll write code. So I wrote a niko­la plug­in which adds sup­port for a large chunk of the Sphinx-spe­cif­ic markup.

How big a chunk? Quite big since it adds sup­port for over 35 ex­ten­sion­s, roles and di­rec­tives (no, toc­tree is not one of them yet).

This way, you may be able to en­joy a good doc­u­men­ta­tion-spe­cif­ic tool and a (if I may say so my­self) good web­site tool from com­mon sources.

En­joy!