MarkdownでもSphinx - Speaker Deck

MarkdownでもSphinx

by Satoshi Miura

Speaker Deck

Tweet

Tweet

Slide 1

Slide 1 text

MARKDOWNͰ΋SPHINX 2016.06.25 PYTHON౦ւ 30TH

Slide 2

Slide 2 text

͓લͩΕΑ > Έ͏Β͞ͱ͠(@mursts) > Python౦ւͷ؅ཧਓͷҰਓͰ͢ > GCPUG Nagoya࢝Ί·ͨ͠(new) > 7/16(౔)ʹGCPUG Nagoya #1

Slide 3

Slide 3 text

υΩϡϝϯτॻ ͍ͯ·͔͢ʁ

Slide 4

Slide 4 text

ΈΜͳେ޷͖

Slide 5

Slide 5 text

Ͱ͸ͳ͘

Slide 6

Slide 6 text

ࠓ೔͸ͬͪ͜Ͱ͢

Slide 7

Slide 7 text

SPHINXͱ͍͑͹

Slide 8

Slide 8 text

RESTRUCTUREDTEXT

Slide 9

Slide 9 text

օ͞Μ͔͚·͢ ͔ʁ

Slide 10

Slide 10 text

MARKDOWNͳΒͲ͏ Ͱ͠ΐ͏ʁ

Slide 11

Slide 11 text

RECOMMONMARK࢖͑͹ SPHINXͰMARKDOWN͕ ࢖͑·͢

Slide 12

Slide 12 text

RECOMMONMARK ?

Slide 13

Slide 13 text

A docutils-compatibility bridge to CommonMark.

Slide 14

Slide 14 text

࢖͍ํ

Slide 15

Slide 15 text

$ pip install sphinx recommonmark

Slide 16

Slide 16 text

conf.py > from recommonmark.parser import CommonMarkParser > > source_parsers = { > '.md': CommonMarkParser, > } > < # source_suffix = ['.rst', '.md'] < source_suffix = '.rst' --- > source_suffix = ['.rst', '.md'] > # source_suffix = '.rst'

Slide 17

Slide 17 text

ޙ͸ɺindex.rstʹ௥Ճͯ͠make html

Slide 18

Slide 18 text

஫ҙ > GitHub Flavored MarkdownʹରԠ͍ͯ͠·ͤΜɻ > CommonMarkͷΈʹରԠ͍ͯ͠·͢ > ςʔϒϧΛ࢖͍͍ͨ৔߹͸reSTͰ

Slide 19

Slide 19 text

RESTRUCTUREDTEXT͸ ۤखͰ΋MARKDOWN ͳΒ࢝ΊΒΕΔ ͔΋ʂ

Slide 20

Slide 20 text

MAKRDOWNͱSPHINXͰ ΋Α͍υΩϡϝ ϯτϥΠϑΛʂ