なぜSphinxで手順書を作るのか /20180425-sphinx-documentation

by opelab

Slide 1

Slide 1 text

Operation Lab ӡ༻ઃܭϥϘ 1 ӡ༻ઃܭϥϘ߹ಉձࣾ γχΞΞʔΩςΫτ೾ా໺༟Ұ ͳͥ4QIJOYͰखॱॻΛ࡞Δͷ͔ TTNKQ

Slide 2

Slide 2 text

Operation Lab ӡ༻ઃܭϥϘ 2 (6*࡞ۀ͔Β ଔۀ͠Α͏ ʮӡ༻ࣗಈԽʯ͢Δલʹ લճͷ͓୊

Slide 3

Slide 3 text

Operation Lab ӡ༻ઃܭϥϘ 3

Slide 4

Slide 4 text

Operation Lab ӡ༻ઃܭϥϘ ӡ༻ࣗಈԽΛߟ͑Δલʹ୤(6*Λ • ࡞ۀ୯Ґͷ੾Γग़͠ํ͕͹Β͖ͭ΍͍͢ɻ • ΦϒδΣΫτࢦ޲ϓϩάϥϛϯάͷجૅΛ஌Βͳ͍ͱ มͳίʔυʹͳΔɻ อकͰ͖ͳ͘ͳΔ • 6*վగͰಈ͔ͳ͘ͳΔ࣮૷ɺ௥͍෇͔ͳ͍ίʔυमਖ਼ɻ ͦ΋ͦ΋(6*࡞ۀͷ ίʔυԽ͸ൺֱత೉͍͠

Slide 5

Slide 5 text

Operation Lab ӡ༻ઃܭϥϘ ίϚϯυ΍"1*ͳͲ௿ϨϕϧͰػೳΛཧղͯ͠࡞ۀ ӡ༻ࣗಈԽΛߟ͑Δલʹ ͳΜͱͳ͘ཧղ͍ͯ͠Ε͹ɺ͕ͭͭͳ͘࡞ۀ׬ྃ (6* $-* 6*վగͰࠞཚ͢Δݱ৔ɺ௥͍෇͔ͳ͍खॱॻվగ 6*վగͷӨڹͳ͠ɺ"1*վగͰ΋৽ػೳΛਖ਼֬ʹ೺Ѳ ௕ظతͳֶशޮՌʹେ͖ͳࠩ ҰาҰา࣮֬ʹ஌ݟ͕ੵΈ্͕͍ͬͯ͘ ·ͣ୤ʮ(6*࡞ۀʯΛਐΊΑ͏

Slide 6

Slide 6 text

ʮӡ༻ࣗಈԽʯͷܦݧଇ 6 ੒ޭͨࣗ͠ಈԽ • ࣗಈԽͷޮՌʹ͍ͭͯɺCFGPSFBGUFS͕໌֬ͳ΋ͷ • ܧଓతʹϝϯςφϯεͰ͖ΔΑ͏ʹૄ݁߹ʹ࡞੒ͨ͠΋ͷ • ໨తΛ໌֬ʹ͠ɺτοϓμ΢ϯࣜʹ࡞੒ͨ͠΋ͷɻ • खॱॻʹԊͬͯ࡞੒ͨ͠΋ͷ • खۙͳͱ͜Ζ͔ΒϘτϜΞοϓࣜʹ࡞੒ͨ͠΋ͷɻ • ʮࣗಈԽʯΛ໨తʹͨ͠΋ͷɻ ਅͷ໨త͕໎૸ͨ͠ • ʮເͷπʔϧʯΛ໨ࢦͨ͠΋ͷɻ ࣦഊͨࣗ͠ಈԽ ৘ใॲཧֶձυΩϡϝϯτίϛϡχέʔγϣϯݚڀୈճݚڀձൃදࢿྉ͔Β Operation Lab ӡ༻ઃܭϥϘ

Slide 7

Slide 7 text

Operation Lab ӡ༻ઃܭϥϘ • खॱॻϕʔεͷࣗಈԽ͸ଞਓͰ΋ཧղ͠΍͍͢ • ࡞ۀखॱΛྲྀΕ࡞ۀԽ͠ɺద੾ʹ੔ཧɾ෼ׂ͢Δ͜ͱͰΘ͔Γ΍͘͢ͳΔɻ • खॱॻϕʔεͷࣗಈԽ͸ϞϊϦγοΫԽΛආ͚΍͍͢ • ͭͷ͜ͱΛ্खʹͰ͖ΔখཻͷखॱॻΛ࡞੒͠ɺखॱ ࢓༷ ʹैͬͯࣗಈॲཧΛ࣮૷ ͢Δ͜ͱͰɺϞϊϦγοΫ େ͖ͳҰմ ԽΛආ͚Δ͜ͱ͕༰қͰ͋Δɻ • खॱॻϕʔεͷࣗಈԽ͸8FC"1*ͱ૬ੑ͕ྑ͍ • ैདྷ͸ॲཧσʔλΛϝϞϦ౉͢͠Δ͜ͱ͕ओྲྀͰɺϑΝΠϧ౉͠͸ʮ֨޷ѱ͍ʯͱ͞ Ε͖ͯͨɻ • 8FC"1*΁ͷ৘ใ఻ୡ͸ϑΝΠϧ౉͠ 1045 ʹͳΔͨΊɺΉ͠ΖϑΝΠϧ౉͠ͷํ͕ ॊೈʹ8FC"1*࿈ܞͰ͖ΔΑ͏ʹͳ͖ͬͯͨɻ • ࡞ۀؒʹ͓͚Δσʔλड͚౉͠ΛϑΝΠϧ౉͢͠Δ͜ͱͰɺ8FC"1*࿈ܞʹΑΔࣗಈ ԽΛࢹ໺ʹೖΕͨखॱΛ࣮ݱ͢Δ͜ͱ͕Ͱ͖Δɻ ৘ใॲཧֶձυΩϡϝϯτίϛϡχέʔγϣϯݚڀୈճݚڀձൃදࢿྉ͔Β खॱΛߏ଄Խ͔ͯ͠ΒࣗಈԽ͢Δ

Slide 8

Slide 8 text

Operation Lab ӡ༻ઃܭϥϘ खॱΛ$-*Խ͔ͯ͠ΒࣗಈԽ͢Δ • $-*ϕʔεͷࣗಈԽ͸ଞਓͰ΋ཧղ͠΍͍͢ • ࡞ۀखॱΛྲྀΕ࡞ۀԽ͠ɺద੾ʹ੔ཧɾ෼ׂ͢Δ͜ͱͰΘ͔Γ΍͘͢ͳΔɻ • $-*ϕʔεͷࣗಈԽ͸ϞϊϦγοΫԽΛආ͚΍͍͢ • ͭͷ͜ͱΛ্खʹͰ͖ΔখཻͷεΫϦϓτΛ࡞੒͠ɺखॱ ࢓༷ ʹैͬͯϑϩʔॲཧ Λ࣮૷͢Δ͜ͱͰɺϞϊϦγοΫ େ͖ͳҰմ ԽΛආ͚Δ͜ͱ͕༰қͰ͋Δɻ • $-*ϕʔεͷࣗಈԽ͸8FC"1*ͱ૬ੑ͕ྑ͍ • ैདྷ͸ॲཧσʔλΛϝϞϦ౉͢͠Δ͜ͱ͕ओྲྀͰɺϑΝΠϧ౉͠͸ʮ֨޷ѱ͍ʯͱ͞ Ε͖ͯͨɻ • 8FC"1*΁ͷ৘ใ఻ୡ͸ϑΝΠϧ౉͠ 1045 ʹͳΔͨΊɺΉ͠ΖϑΝΠϧ౉͠ͷํ ͕ॊೈʹ8FC"1*࿈ܞͰ͖ΔΑ͏ʹͳ͖ͬͯͨɻ • ࡞ۀؒʹ͓͚Δσʔλड͚౉͠ΛϑΝΠϧ౉͢͠Δ͜ͱͰɺ8FC"1*࿈ܞʹΑΔࣗಈ ԽΛࢹ໺ʹೖΕͨखॱΛ࣮ݱ͢Δ͜ͱ͕Ͱ͖Δɻ

Slide 9

Slide 9 text

Operation Lab ӡ༻ઃܭϥϘ 4QIJOYͰ͸͡ΊΔखॱॻۦಈӡ༻

Slide 10

Slide 10 text

Operation Lab ӡ༻ઃܭϥϘ 4QIJOYલ࢙ 10 ಄͔Β͓৲·Ͱ ਓ͕खͰॻ͘͜ͱ Λ૝ఆ͍ͯ͠·ͤΜ͔? खॱॻΛॻ͕࣌ؒ͘

Slide 11

Slide 11 text

Operation Lab ӡ༻ઃܭϥϘ 4QIJOYલ࢙ 11 खॱΛXMLͰखॻ͖ XSLTͰύʔεͯ͠HTMLԽ ͦΜͳ࣌୅͕ ࣗ෼ʹ΋͋Γ·ͨ͠

Slide 12

Slide 12 text

Operation Lab ӡ༻ઃܭϥϘ 4QIJOYલ࢙ 12 91BUIͭΒ͍ खॱΛXMLͰखॻ͖ XSLTͰύʔεͯ͠HTMLԽ

Slide 13

Slide 13 text

Operation Lab ӡ༻ઃܭϥϘ ͳͥɺ9.-ʹ͔ͨ͠ ೥ࠒ 13 Doc ΠϯΫϧʔυ ΠϯΫϧʔυΛલఏͱ͢Δ࣌୅΁ ࠶ར༻Λલఏ ݸผࣄ৘Λهड़ when where who what how υΩϡϝϯτࢿ࢈Λ࠶ར༻͢Δ why ਓ͕ຖճهड़͢Δ ౰࣌͸ϚογϡΞοϓͷᴈ໌ظ

Slide 14

Slide 14 text

Operation Lab ӡ༻ઃܭϥϘ ͳͥΠϯΫϧʔυ 14 Doc ΠϯΫϧʔυ खॻ͖Λલఏͱ͠ͳ͍࣌୅΁ ࠶ར༻Λલఏ ݸผࣄ৘Λهड़ when where who what how υΩϡϝϯτࢿ࢈Λ࠶ར༻͢Δ why ਓ͕ຖճهड़͢Δ γΣϧεΫϦϓτͰ (൒)ࣗಈੜ੒

Slide 15

Slide 15 text

Operation Lab ӡ༻ઃܭϥϘ ٹੈओͷొ৔ 15 γΣϧεΫϦϓτͰੜ੒ͨ͠खॱॻΛ SphinxͰΠϯΫϧʔυͯ͠HTMLԽ Ͱ͖Δ

Slide 16

Slide 16 text

ΠϯΫϧʔυΛ׆༻͢ΔυΩϡϝϯςʔγϣϯ • $47σʔλΛΠϯΫϧʔυͯ͠ςʔϒϧදࣔ • ιʔείʔυΛΠϯΫϧʔυͯ͠ϋΠϥΠτදࣔ • ιʔείʔυͷಛఆൣғΛΠϯΫϧʔυͯ͠දࣔ • ஔ׵ͷఆٛͱద༻৔ॴͷهड़ΛΠϯΫϧʔυ • υΩϡϝϯτͷύʔπΛΠϯΫϧʔυ SF45SVDUVSFE5FYUܗࣜ Operation Lab ӡ༻ઃܭϥϘ Ұ౓ॻ͍ͨυΩϡϝϯτͷ࠶ར༻΍γεςϜͷग़ྗ Λ׆͔ͨ͠൒ࣗಈυΩϡϝϯςʔγϣϯ ଟ࠼ͳΠϯΫϧʔυػೳ

Slide 17

Slide 17 text

Operation Lab ӡ༻ઃܭϥϘ ࣄྫ

Slide 18

Slide 18 text

ΠϯΫϧʔυΛ׆༻͢ΔυΩϡϝϯςʔγϣϯ Operation Lab ӡ༻ઃܭϥϘ υΩϡϝϯτͷύʔπΛΠϯΫϧʔυ SF45SVDUVSFE5FYUܗࣜ खॱॻ 4QIJOY खॱύʔπ ΠϯΫϧʔυ खॱύʔπ ΠϯΫϧʔυ

Slide 19

Slide 19 text

ΠϯΫϧʔυΛ׆༻͢ΔυΩϡϝϯςʔγϣϯ Operation Lab ӡ༻ઃܭϥϘ ஔ׵ͷఆٛͱద༻৔ॴͷهड़ΛΠϯΫϧʔυ खॱॻ 4QIJOY ஔ׵ςʔϒϧ ஔ׵จࣈྻ ΠϯΫϧʔυ ஔ׵ςʔϒϧͷهड़ʹैͬͯ खॱॻͷ֘౰෦෼͕ॻ͖ସΘΔɻ

Slide 20

Slide 20 text

ΠϯΫϧʔυΛ׆༻͢ΔυΩϡϝϯςʔγϣϯ Operation Lab ӡ༻ઃܭϥϘ $47σʔλΛΠϯΫϧʔυͯ͠ςʔϒϧදࣔ $47ϑΝΠϧ 4QIJOY DTWUBCMF σΟϨΫςΟϒ εΫϦϓτ ࣗಈੜ੒ ςʔϒϧදࣔ

Slide 21

Slide 21 text

ΠϯΫϧʔυΛ׆༻͢ΔυΩϡϝϯςʔγϣϯ Operation Lab ӡ༻ઃܭϥϘ ιʔείʔυΛΠϯΫϧʔυͯ͠ϋΠϥΠτදࣔ ૢ࡞ର৅ 4QIJOY MJUFSBMJODMVEF σΟϨΫςΟϒ γΣϧ εΫϦϓτ ࣗಈ࣮ߦՄೳ ίϚϯυखॱ खಈ࣮ߦՄೳ

Slide 22

Slide 22 text

Operation Lab ӡ༻ઃܭϥϘ ࣄྫ+"846($-*ઐ໳ࢧ෦ 22 ENV FLOW RESULT API ίϚϯυ γφϦΦ ϋϯζΦϯखॱ γΣϧεΫϦϓτͰੜ੒ + ΧελϜ ਓ͕هड़ ΠϯΫϧʔυ ࡞Γஔ͖ͨ͠େྔͷυΩϡϝϯτϞδϡʔϧΛ ΠϯΫϧʔυͯ͠ɺ৽نυΩϡϝϯτΛ࡞੒ ཁૉਤ ճ։࠵த໿ճ෼ 4QIJOYͷ׆༻ྫ ࢖͍ࣺͯखॱ

Slide 23

Slide 23 text

Operation Lab ӡ༻ઃܭϥϘ ࠷ۙ+"846($-*ઐ໳ࢧ෦ 23 γΣϧεΫϦϓτͰ શ໘తʹࣗಈੜ੒Խ Doc ΠϯΫϧʔυ ࠶ར༻Λલఏ ݸผࣄ৘Λهड़ when where who what how υΩϡϝϯτࢿ࢈Λ࠶ར༻͢Δ why ਓ͕ຖճهड़͢Δ

Slide 24

Slide 24 text

Operation Lab ӡ༻ઃܭϥϘ 24 ࿦ཧతͳໃ६΍ෆ੔߹ΛഉআͰ͖Δ ࣄલ৚݅ɺࣄޙ৚݅ͷଥ౰ੑ ࣗಈੜ੒ʹඞཁͳཁૉ खॱॻࣗಈੜ੒ԽͷϝϦοτ ࿦ཧతͳਖ਼͠͞ (໨తద߹ੑ) ࿦ཧతͳ੔߹ੑ ໋໊نଇ΍໊લۭؒͷنଇԽ͕ਐΉߋʹࣗಈԽ͠΍͘͢ͳΔ

Slide 25

Slide 25 text

Operation Lab ӡ༻ઃܭϥϘ -FU`TCVZ

Slide 26

Slide 26 text

Operation Lab ӡ༻ઃܭϥϘ ·ͱΊ

Slide 27

Slide 27 text

Operation Lab ӡ༻ઃܭϥϘ ·ͱΊखॱॻͷ࡞Γํ 27 when where who what how υΩϡϝϯτࢿ࢈Λ࠶ར༻͢Δ why ਓ͕ຖճهड़͢Δ Doc ΠϯΫϧʔυ ΠϯΫϧʔυΛલఏͱ͢Δ࣌୅΁ ࠶ར༻Λલఏ ݸผࣄ৘Λهड़ Ұ౓ॻ͍ͨυΩϡϝϯτͷ࠶ར༻΍γεςϜͷग़ྗ Λ׆͔ͨ͠൒ࣗಈυΩϡϝϯςʔγϣϯ

Slide 28

Slide 28 text

Operation Lab ӡ༻ઃܭϥϘ 28 ΠϯΫϧʔυΛલఏͱ͢Δ࣌୅΁ MarkdownܗࣜΛຖճखͰॻ͖·͔͢? SphinxͰυΩϡϝϯτࢿ࢈Λ ΠϯΫϧʔυ͠·͔͢? υΩϡϝϯτͷ࠶ར༻͕લఏ ·ͱΊखॱॻͷ࡞Γํ

Slide 29

Slide 29 text

Operation Lab ӡ༻ઃܭϥϘ େࣄͳ͜ͱ͸ʮۀ຿ͷߏ଄Խʯ ʮ໰୊ΛࠜੑͰղܾ͢Δͷ͸അࣛͰ͢ɻ ໰୊ΛΤϯδχΞϦϯάͰղܾ͢Δͷ͕ ΤϯδχΞͷ࢓ࣄͰ͢ʯ !ZPTIJPSJ ߏ଄Խ ͜͜Ͱ͸ʮΤϯδχΞϦϯά ޻ֶ ͷ࣮ફʯʹ͍ۙҙຯͰ࢖͍·͢ɻ ޻ֶͰ͸ԿΒ͔ͷߏ଄෺ɾߏ଄ମΛ࡞Δ͜ͱ͕ෆՄආͳͨΊͰ͢ɻ http://d.hatena.ne.jp/Yoshiori/20120217/1329491437

Slide 30

Slide 30 text

Operation Lab ӡ༻ઃܭϥϘ 30 ʮӡ༻ࣗಈԽʯΑΓ΋ ʮӡ༻ߏ଄Խʯͷະདྷ΁ ·ͣ͸ͪΌΜͱͨ͠ ߏ଄తͳ खॱॻΛॻ͜͏ ࣗಈԽ͸ͦͷઌͷ࿩ͩ

Slide 31

Slide 31 text

Operation Lab ӡ༻ઃܭϥϘ 31 IUUQXXXPQFSBUJPOMBCDPKQ OperationLab ӡ༻ઃܭ