Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Sphinxで 大量にドキュメントを手軽に作るための工夫/20200610-stapy-sphinx

Sphinxで 大量にドキュメントを手軽に作るための工夫/20200610-stapy-sphinx

みんなのPython勉強会#58 ( https://startpython.connpass.com/event/175451/ )での発表資料です。

概要: Sphinxは、知識や経験のインプットとアウトプットを構造化できる強力なツールです。時間が無いときは簡単な構造でメモしておき、時間が取れるときにしっかり構造化してあげることで、自分の暗黙的な知識や物の見方がみるみる構造化されていきます。
日本UNIXユーザ会 2010年12月勉強会「ドキュメントを作りたくなってしまう魔法のツール Sphinx」(講師: 渋川さん、山口さん、清水川さん)をきっかけにSphinxを使いはじめ、年間数千の構造化ドキュメントを書くなかでやってきた「Sphinxを使う上での工夫」についてお話しします。

(運用設計ラボ合同会社 波田野裕一)

opelab

June 10, 2020
Tweet

More Decks by opelab

Other Decks in Technology

Transcript

  1. Operation Lab ӡ༻ઃܭϥϘ ࢲͱӡ༻खॱॻ 3 ‣ ೥୅લ൒໷ؒ࡞ۀ࣌ͷࣗ෼͕৴͡ΒΕͳ͍ͷͰɺ ट͔ΒԼͰ࣮ߦͰ͖ΔखॱॻΛ࡞੒ ‣ ೥୅ޙ൒खॻ͖9.-

    94-5 YTMUQSPD ͰΠϯ ΫϧʔυՄೳͳखॱॻΛ࡞੒ ೥ఔ౓Ͱ࠳ં  ‣ ೥4QIJOYͱग़ձ͍ɺखॱॻͷߏ଄ԽΛਐΊΔɻ ‣ ݱࡏ໿ʙ೥ͷखॱॻΛಠΓͰ࡞੒ɻ ʮڀۃͷӡ༻खॱॻʯΛ௥͍ٻΊΔ׆ಈΛ͍ͯ͠·͢ ࣗݾ঺հͱηογϣϯ֓ཁ
  2. • ೔ຊͷ"84ϢʔβίϛϡχςΟͷҰͭɻ • ڵຯର৅͸ɺ6OJpFE"84$-* • ઃཱ • "844VNNJU%BZ • ։࠵ճ

    ϋϯζΦϯճ υΩϡϝϯτ׆ಈ+"846($-*ઐ໳ࢧ෦ ϋϯζΦϯ͋ͨΓͷखॱॻ ࣗݾ঺հͱηογϣϯ֓ཁ • ฏۉ໿ຕ • ࠷େຕ ͜͜Λ͖͔͚ͬʹΫϥ΢υస৬͢Δਓଟ਺
  3. Operation Lab ӡ༻ઃܭϥϘ Ԗච υΩϡϝϯτ࡞੒ͷաڈɺݱࡏ 11 ೖग़ྗͷ෼཭ لݩલ೥ࠒʙ ੈل຤ खॻ͖

    ๽ච ໦൛ҹ࡮ ׆൛ҹ࡮ ฏ൘ҹ࡮ λΠϓϥΠλʔ ϫʔϓϩ Ճ޻֓೦ͷ஀ੜ ਵ࣌ग़ྗ ࢴ ϓϦϯλʔ ηϚϯςΟοΫ8FC ೪౔൘ɺ໦؆ ೖྗ ग़ྗ ੈلޙ൒ لݩલ೥ࠒʙ ੈلޙ൒ ੈلதࠒ ੈلࠒ ೖग़ྗҰମ ੈل຤ࠒ Ճ޻ͱग़ྗͷࣗಈԽ 8FC ੈلॳ಄ ೖྗٕज़ ग़ྗٕज़ Ճ޻ٕज़ ݻఆେྔग़ྗ ࢴ ·ͩखೖྗ͕લఏ
  4. Operation Lab ӡ༻ઃܭϥϘ υΩϡϝϯτ࡞੒ͷݱࡏ͔Βະདྷ΁ 12 ηϚϯςΟοΫ8FC Ճ޻ͱग़ྗͷࣗಈԽ 8FC ੈلॳ಄ ೖྗٕज़

    ग़ྗٕज़ Ճ޻ٕज़ ͕͜͜ະͩ खॻ͖ɾखೖྗ ೖྗ ग़ྗ ʮυΩϡϝϯτͷશͯΛਓ͕ॻ͘ʯͱ͍͏؍೦͔Βͷ୤٫͕ඞཁ ਓͷखͰશͯॻ͜͏ͱ͢Δ͔Β ʮυΩϡϝϯτݏ͍ʯʹͳΔ
  5. Operation Lab ӡ༻ઃܭϥϘ υΩϡϝϯτ࡞੒ͷະདྷXJUI4QIJOY 13 ೖྗٕज़ ग़ྗٕज़ Ճ޻ٕज़ ೖྗ ग़ྗ

    reSTructured Text Parser Builder Theme reSTructured Text ਓ͕ॻ͘ ػց͕ॻ͘ Ϛγϯ • υΩϡϝϯτͷ͏ͪɺਓ͕ॻ͘෦෼ͱɺػցʹॻ͔ͤΔ෦෼Λҙࣝతʹ෼཭͢Δɻ • ػցʹॻ͔ͤΔυΩϡϝϯτΛ໌֬ʹ͢Δ • $47΍:".-ͳͲͷՄಡੑͷߴ͍ߏ଄Խσʔλ • ݴޠͷώΞυΩϡϝϯτػೳͰੜ੒Ͱ͖Δσʔλ • ੲ͸ɺ9.-΋༗ޮͩͬͨ • ػցʹॻ͔ͤͨυΩϡϝϯτύʔπΛɺਓ͕ॻ͍ͨυΩϡϝϯτ͔ΒΠϯΫϧʔυ͢Δɻ
  6. Operation Lab ӡ༻ઃܭϥϘ υΩϡϝϯτ࡞੒ΛਓͱػցͰ෼୲͢Δ 18 • υΩϡϝϯτͷ͏ͪɺਓ͕ॻ͘෦෼ͱɺػցʹॻ͔ͤΔ෦෼Λҙࣝతʹ෼཭͢Δɻ • ػցʹॻ͔ͤΔυΩϡϝϯτΛ໌֬ʹ͢Δ •

    $47΍:".-ͳͲͷՄಡੑͷߴ͍ߏ଄Խσʔλ • ݴޠͷώΞυΩϡϝϯτػೳͰੜ੒Ͱ͖Δσʔλ • ੲ͸ɺ9.-΋༗ޮͩͬͨ • ػցʹॻ͔ͤͨυΩϡϝϯτύʔπΛɺਓ͕ॻ͍ͨυΩϡϝϯτ͔ΒΠϯΫϧʔυ͢Δɻ 4QIJOYͷΠϯΫϧʔυػೳ͕ڧྗ 4QIJOYͷஔ׵ػೳ͕ڧྗ ೖྗٕज़ ग़ྗٕज़ Ճ޻ٕज़ ೖྗ ग़ྗ reSTructured Text reSTructured Text ਓ͕ॻ͘ ػց͕ॻ͘ Ϛγϯ
  7. Operation Lab ӡ༻ઃܭϥϘ ͲͷΑ͏ʹਓͱػցͰ෼୲͢Δ͔ 19 ਓ͕ॻ͘ ػց͕ॻ͘ Ϛγϯ ਓʹ͔͠ॻ͚ͳ͍෦෼Λॻ͘ ਓ͕ॻ͔ͳͯ͘΋ྑ͍ͱ͜ΖΛ

    ॻ͘ ʮػց͕ॻ͚Δͱ͜ΖΛॻ͘ʯͩͱ͍ͭ·Ͱܦͬͯ΋ ਓ͕ॻ͘υΩϡϝϯτ͸ݮΒͳ͍ গ͠ແཧͯ͠΋ػցʹॻ͔ͤΔ
  8. 4QIJOYͷॏཁͳػೳ • ΠϯΫϧʔυػೳ • JODMVEF SF45ϑΝΠϧΛΠϯΫϧʔυ͢Δ  • MJUFSBMJODMVEF ιʔείʔυΛΠϯΫϧʔυ͢Δ

     • DTWUBCMF DTWϑΝΠϧΛΠϯΫϧʔυ͢Δ  • ஔ׵ػೳ • ςϯϓϨʔτͷಛఆͷ৔ॴΛॻ͖׵͑ͯग़ྗͰ͖Δ • UPDUSFF • จॻߏ଄ΛܾΊΔ Operation Lab ӡ༻ઃܭϥϘ 22
  9. • 3&$جૅ &#4    • 3&$جૅ ".* 

      • 3*".ೖ໳   • 3*".جૅ *".ϙϦγʔ    • 3*".جૅ *".ϩʔϧ    • 3*".جૅ ΠϯελϯεϓϩϑΝΠϧ  ্݄० એ఻+"846($-*ઐ໳ࢧ෦ΦϯϥΠϯ ࣗݾ঺հͱηογϣϯ֓ཁ खॱॻ͸શͯ4QIJOYͰ࡞੒