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

ソフトウェア工学12 ドキュメンテーション

ソフトウェア工学12 ドキュメンテーション

ドキュメンテーション

コメント,リファレンスマニュアル,Docstring,自動ドキュメント生成,Sphinx,Doxygen,マークアップ言語,Markdown,RST,pandoc

99b434b001cd93fe73322f764d73372c?s=128

Toru Tamaki

August 05, 2021
Tweet

Transcript

  1. ιϑτ΢ΣΞ޻ֶ nυΩϡϝϯςʔγϣϯ • ίϝϯτɼϦϑΝϨϯεϚχϡΞϧɼDocstringɼࣗಈυ Ωϡϝϯτੜ੒ɼSphinxɼDoxygenɼϚʔΫΞοϓݴޠɼ MarkdownɼRSTɼpandoc ۄ໦పʢ໊޻େʣ

  2. υΩϡϝϯςʔγϣϯ

  3. υΩϡϝϯτ͸ॏཁ nϓϩδΣΫτ։ൃͰ͸ඞਢ • ඼࣭؅ཧͷͨΊ • νʔϜϝϯόʔؒͷҙࢥૄ௨ͷͨΊ • ઃܭͱ࣮૷ͱςετ͸ผਓ͕ߦ͏ͨ Ί nυΩϡϝϯτͷछྨ

    • ϓϩδΣΫτ؅ཧ • ٞࣄ࿥ɼ؅ཧܭըɾه࿥ද • ࢓༷ॻ • ཁٻ࢓༷ॻ • WBSɼΨϯτνϟʔτ • ֎෦ઃܭॻ • ߏ੒ਤɼۀ຿ϑϩʔਤɼը໘ ભҠਤɼɽɽɽ • ಺෦ઃܭॻ • ৄࡉઃܭॻɼΠϕϯτఆٛॻɼ Ϋϥεఆٛॻɼ֤छUML ਤɼɽɽɽ • ςετ࢓༷ॻɾ࣮ࢪ݁Ռใࠂॻ • ίʔυͷίϝϯτ • ίʔυͷઆ໌จ • ؔ਺ͳͲͷΠϯλʔϑΣʔε
  4. ίϝϯτ nίʔυதͰ࣮ߦ͞Εͳ͍෦෼ • ਓؒʹͱͬͯҙຯͷ͋Δ৘ใΛ ॻͨ͘Ί nίϝϯτͷํ๏ • ߦ಺ͷ͋Δ෦෼͔Βߦ຤·Ͱͷ ίϝϯτ •

    ෳ਺ߦ͔ΒͳΔίϝϯτ nίϝϯτΞ΢τ • ίʔυͷҰ෦Λίϝϯτʹ͢Δ ͜ͱ PytorchͷConv1D
  5. ίϝϯτͷॻ͖ํ͸ݴޠґଘ nCݴޠ /* comment */ /* comment */ nC++ //

    comment /* comment */ /* comment */ nJava // comment /* comment */ nPython # comment """ comment """
  6. ྑ͍ίϝϯτͱѱ͍ίϝϯτ nྑ͍ίϝϯτ • ͦͷίʔυ͕ଘࡏ͢Δཧ༝Λॻ͘ nѱ͍ίϝϯτ • ͦͷίʔυ͕ߦ͍ͬͯΔ಺༰Λॻ ͘ • ѱ͍ཧ༝

    • ίʔυͦΕࣗମ͕ॲཧ಺༰Λද ͍ͯ͠ΔͷͰෆཁ • ίʔυͱίϝϯτͷ2ͭΛ؅ཧ ͠ͳ͚Ε͹ͳΒͳ͍ͷͰແବͳ ख͕ؒ૿͑Δ nͰ͖Δ͚ͩίϝϯτ͸ॻ͔ͳ͍ • ඞཁ࠷খݶʹ͢Δ • ྑ͍ίʔυʹ͸΄ͱΜͲίϝϯτ ͕ͳ͍ • ϩδοΫ΋໌շ • ͦ΋ͦ΋ઃܭॻ͕͋Δ • ؔ਺΍ม਺໊͕Θ͔Γ΍͍͢ • ίϝϯτ͸ෆཁ ࠷ѱͷίϝϯτ
  7. ྑ͍ίϝϯτͱѱ͍ίϝϯτ nॻ͘΂͖ίϝϯτ • ͳͥͦͷΑ͏ʹίʔυ͕ॻ͔Εͯ ͍Δͷ͔Λॻ͘ • Կ͕ୡ੒͞ΕΔͷ͔Λॻ͘ • ଞਓ͕ಡΉ͜ͱΛલఏʹͯ͠ॻ͘ nͦ΋ͦ΋

    • Ͱ͖Δ͚ͩίϝϯτΛॻ͔ͣʹࡁ ΉΑ͏ʹίʔυΛॻ͘ nॻ͘΂͖Ͱͳ͍ίϝϯτ • ม਺ͷઆ໌ • ม਺໊ࣗମ͕ৄ͍͠಺༰Λද͠ ͍ͯΕ͹Α͍ • ϚδοΫφϯόʔͷઆ໌ • ͦΕΒΛද͢Θ͔Γ΍͍͢ม਺ Λ࢖͑͹ྑ͍ • վมཤྺ΍࣌ࠁ • όʔδϣϯ؅ཧΛ࢖͑͹Α͍ • ࣗ෼༻ͷϝϞ • ίʔυΛԚછͯ͠͠·͏
  8. ϦϑΝϨϯεϚχϡΞϧ APIϦϑΝϨϯε

  9. ϚχϡΞϧͱ͸ nϦϑΝϨϯεϚχϡΞϧ • ػೳΛҰཡʹͨ͠υΩϡϝϯτ • ؔ਺΍Ϋϥεɼϝιουͷ࢖͍ํ • Ҿ਺ͱฦΓ஋ͷҙຯ • ࢖༻ྫ

    nυΩϡϝϯτͷҰछ • ࡞੒ͨ͠Ϟδϡʔϧͷίʔυͱಉ༷ʹೲ඼ • ͨͩ͠ίʔυͱϚχϡΞϧΛผʑʹ࡞੒͢Δͱೋ౓खؒ • ؅ཧ΋ೋॏʹͳΔͷͰϛε͕ൃੜ͠΍͍͢
  10. 1ZUIPOͷϚχϡΞϧ nެࣜυΩϡϝϯτ • ࢖͍ํ͸͔͜͜Βௐ΂Δ https://docs.pyt hon.org/ja/3/ https://docs.python.org/ja/3/library/math.html

  11. ϥΠϒϥϦͷϚχϡΞϧ https://pytorch.org/docs/stable/generat ed/torch.nn.Conv2d.html https://numpy.org/doc/stable/referenc e/generated/numpy.arctan2.html nެࣜυΩϡϝϯτ • ࢖͍ํ͸͔͜͜Βௐ΂Δ

  12. ϚχϡΞϧͷදࣔ https://docs.python.org/3/library/math.html ΤσΟλʹΑͬͯ͸Ϛ ΢εΦʔόʔͰϚχϡ ΞϧΛදࣔ͢Δ pythonͷhelpίϚϯυ ͸ϚχϡΞϧΛදࣔ͢ Δ webϚχϡΞϧ͸ެࣜ αΠτʹ͋Δ

  13. %PDTUSJOH nPythonͷ࢓༷ʢPEP275ʣ • ؔ਺΍Ϋϥεͷ࢓༷Λઆ໌͢Δίϝϯτ • એݴͷ๯಄ͷจࣈྻϦςϥϧ͕docstringʹͳΔ docstring ࣗ࡞ؔ਺Ͱ΋ docstring͕ද ࣔ͞ΕΔ

  14. docstringΛݕࡧͯ͠Π ϯετʔϧ

  15. ؔ਺΍Ϋϥεͷએݴͷ ௚ޙʹ”””Λೖྗ͢Δͱɼ docstringੜ੒ػೳ͕ಇ ͘ ͜ΕΛԡ͢ͱ ΋͘͠͸ίϚϯυύ Ϩοτ͔ΒGenerate DocstringΛબ୒͢Δͱ ੜ੒͞ΕΔ

  16. ϑΥʔϚοτʹ ԊͬͨςϯϓϨʔ τ͕ૠೖ͞ΕΔ ඞཁͳ৘ใΛೖྗ ͢Ε͹׬੒

  17. ϚχϡΞϧͷ࡞੒ͱੜ੒ sphinx doxygen

  18. ϚχϡΞϧͷࣗಈ࡞੒ nϚχϡΞϧ࡞੒ͷ໰୊఺ • ίʔυͱϚχϡΞϧΛผʑʹ࡞੒͢Δͱೋ౓खؒ • ؅ཧ΋ೋॏʹͳΔͷͰϛε͕ൃੜ͠΍͍͢ • ϚχϡΞϧΛෳ਺ͷϝσΟΞͰఏڙ͢Δ͜ͱ΋ଟ͍ • ྫɿHTML൛ͱPDF൛

    • ผʑʹ࡞੒ɾ؅ཧ͢Δ͜ͱ͸ඇޮ཰ nղܾࡦ • ن໿ʹԊͬͯॻ͔ΕͨDocstring͔ΒϚχϡΞϧΛࣗಈੜ੒ • ίʔσΟϯά࣌ʹϚχϡΞϧͷ৘ใ΋هड़͢Δ
  19. 1ZUPSDIͷྫ https://pytorch.org/docs/stable/generat ed/torch.nn.Conv2d.html ֘౰͢Διʔείʔυ https://github.com/pytorch/pytorch/blob /master/torch/nn/modules/conv.py

  20. 4QIJOY

  21. 4QIJOY nυΩϡϝϯτ࡞੒πʔϧ • ೖྗ • DocstringΛؚΉίʔυ • ग़ྗ • HTML΍PDFܗࣜͷϚχϡΞϧ

    • ݩʑ͸Python༻ • ݱࡏ͸ଞͷݴޠʹ΋ରԠ https://www.sphinx-doc.org/ja/master/
  22. 4QIJOYͷྫ n༻ҙͨ͠ϑΝΠϧ • compute.py • integration.py • main.py nDocstring •

    ςϯϓϨʔτʹैͬͯهࡌ
  23. TQIJOYRVJDLTUBSU ੜ੒͞ΕΔ σΟϨΫτ Ϧ ʮyʯΛೖྗ ʢbuildͱsource ʹ෼͔ΕΔʣ υΩϡϝϯτΛ࡞੒ ͢ΔσΟϨΫτϦ ϓϩδΣΫτͷ৘ใΛೖྗ

    ʢࣗ෼ͷ໊લΛೖΕΔ͜ͱʣ ೔ຊޠͳΒjaͱೖྗ͢Δ ʢenͳΒӳޠʣ ઃఆ͸ conf.pyʹ ه࿥͞Ε Δ
  24. EPDTTPVSDFDPOGQZͷฤू patchͰ΍ΔͳΒ conf.pyʹର͢Δ ιʔείʔυͷ ͋ΔҐஔͷมߋ ࣗಈ࡞੒ͷ֦ுΛ௥Ճ ʢৄ͘͠͸ͪ͜Βʣ ςʔϚΛRead the Docʹมߋ

    खಈͰमਖ਼͢ΔͳΒ ΋͘͠͸
  25. TQIJOYBQJEPD ϑΝΠϧΛ্ॻ͖ -oͰੜ੒தؒϑΝΠϧ ʢrstʣΛอଘ͢Δ σΟϨΫτϦΛࢦఆ ιʔείʔυͷ͋Δ ϑΥϧμΛࢦఆ ֤ιʔείʔυʹର ͯ͠rst͕࡞੒͞ΕΔ

  26. TQIJOYCVJME docs/sourceʹ͋Δrst ϑΝΠϧΛ࢖ͬͯ HTML͕ੜ੒͞Εͨ ੜ੒͞ΕΔhtmlϑΝΠ ϧΛdocs/build/htmlʹ อଘ HTMLϑΝΠ ϧΛੜ੒͢Δ ࢦఆ

  27. JOEFYIUNM

  28. NPEVMFTIUNM compute.html

  29. %PYZHFO

  30. %PYZHFO nυΩϡϝϯτ࡞੒πʔϧ • ೖྗ • ίϝϯτʹDoxygenίϚϯυΛ ΛؚΉίʔυ • ग़ྗ •

    HTML΍PDFܗࣜͷϚχϡΞϧ • C, C++, Java, PythonͳͲ • Docstringͱ͸ҟͳΔಠࣗϑΥʔϚο τ https://www.doxygen.nl/ ஫ҙɿ http://www.doxygen.jp ͸10 ೥ϝϯς͞Εͯͳ͍ɽɽɽ
  31. %PYZHFOͷྫ n༻ҙͨ͠ϑΝΠϧ • compute.py • integration.py • main.py nίϝϯτ •

    DoxygenελΠϧʹैͬͯهࡌ main.py compute.py integration.py @͔Β࢝·Δ΋ͷ͕ DoxygenίϚϯυ ྫɿ@fn͸ؔ਺ʹର ͢ΔDoxygenίϚϯ υ
  32. $ݴޠͷྫ

  33. ઃఆϑΝΠϧɿ%PYZGJMF ϓϩδΣΫτ໊ͳͲ ιʔείʔυͷϑΝ Πϧ໊ύλʔϯ HTMLΛੜ੒͢Δࢦ ఆʢNOͳΒHTMLΛ ࡞Βͳ͍ʣ

  34. %PYZHFOͷ࣮ߦ ɽɽɽ ઃఆϑΝΠϧ DoxyfileΛࢦఆ ͜ͷதͷ index.html

  35. ੜ੒υΩϡϝϯτ index.html

  36. doxygenΛݕࡧͯ͠Π ϯετʔϧ

  37. ؔ਺ͷ௚લͰίϝϯτ Λ։࢝ͯ͠ϦλʔϯΛ ԡ͢ͱ ϑΥʔϚοτʹैͬͨ ςϯϓϨʔτ͕ૠೖ͞ ΕΔ

  38. ஫ɿσϑΥϧτઃఆͰ ͸ίϝϯτ͸Cݴޠͷ ΈରԠ

  39. %PYZHFO WT4QIJOY

  40. 0QFO$7GSPN4QIJOYUP%PYZHFO https://docs.opencv.org

  41. 0QFO$7%PYZHFO https://docs.opencv.org/4.5.2/annotated.html

  42. 1$-%PYZHFO https://pointclouds.org/documentation/annotated.html

  43. /VNQZ4QIJOY https://numpy.org/doc/stable/reference/routines.char.html

  44. 4DJLJUMFBSO4QIJOY https://scikit- learn.org/stable/modules/generated/sklearn.svm.LinearSV C.html#sklearn.svm.LinearSVC

  45. 1ZUPSDI4QIJOY https://pytorch.org/docs/stable/index.html

  46. 1ZUPSDIBOE%PYZHFO https://pytorch.org/docs/stable/community/contribution_gui de.html#on-documentation

  47. %PYZHFO WT4QIJOYదࡐదॴ nSphinx • ςʔϚͷࣗ༝౓͕େ͖͍ • ࠷ۙओྲྀʁ • python͸Docstring nDoxygen

    • Ϋϥε֊૚͕ෳࡶͳ৔߹ʹ͸ศར • graphvis΋ซ༻͢ΔͱUMLͷΫϥ εਤ͕ຒΊࠐΊΔ nHTMLͰͷ਺ࣜදࣔ • katex • mathjax
  48. ϚʔΫΞοϓݴޠ Markdown (md) reStructuredText (rst)

  49. ϚʔΫΞοϓݴޠͱ͸ nϓϨʔϯςΩετͰߏ଄Խ͞ΕͨจॻΛ࡞੒͢Δ • wikipediaͷఆٛɿจॻʹ஫ऍΛ෇͚ΔͨΊͷํ๏ɼຊจͷςΩετͱ͸ߏจత ʹ۠ผͰ͖Δ • ྫɿHTMLʢHyperText Markup Languageʣ •

    ଟ਺ͷݴޠ͕͋Δ • https://en.wikipedia.org/wiki/List_of_markup_languages n༻్ • গ͠ϑΥʔϚοτΛ͚ͭͯखܰʹυΩϡϝϯτΛॻ͖͍ͨ • ίϝϯτʹ࠷ద • ୅දྫ • Markdownʢ֦ுࢠ.mdʣ • reStructuered Textʢ֦ுࢠ.rstʣ
  50. 0GGJDF͸8:4*8:( nWYSIWYGʢ΢Οδ΢Οάʣ·ͨ͸WYSWYGʢ΢Οζ΢Οάʣ • What You See Is What You Getʢݟͨͱ͓Γͷ΋ͷ͕ಘΒΕΔʣͷ಄จࣈ

  51. .BSLEPXO͸ϓϨʔϯςΩετ nೖྗ͸ςΩετΤ σΟλ nදࣔʹ͸Ϩϯμ ϥʔ͕ඞཁ • ਺ࣜ΋දࣔͰ͖Δ

  52. MarkdownͰݕࡧ

  53. ؆୯ͳ.BSLEPXOจ๏ # Markdownͷจ๏ ## Ϧετ - Օ৚ॻ͖ - ͜͏ͳΓ·͢ -

    ΠϯσϯτΛ2ͭԼ͛Δͱ - Ϩϕϧ্͕͕Γ·͢ - Օ৚ॻ͖ - Օ৚ॻ͖ - Օ৚ॻ͖
  54. ؆୯ͳ.BSLEPXOจ๏ ## ίʔυ ίʔυΛೖྗ͢Δ৔߹͸ҎԼͷΑ͏ͳίʔυϒ ϩοΫΛ࢖͍·͢ɽ ```python:test.py def myfunc(a, b, c):

    a = b + c print(a) ```
  55. ؆୯ͳ.BSLEPXOจ๏ ## ਺ࣜ ϨϯμϥʹΑͬͯ͸$y = f(x)$ͷΑ͏ͳ LaTeX਺ࣜ΋ରԠ͍ͯ͠·͢ɽΠϯϥΠϯ͚ͩ Ͱͳ͘ɼߦཱͯͷ਺ࣜ $$ y

    = ¥int_a^b f(x, t) dt $$ ΋ରԠ͍ͯ͠·͢ɽ਺ࣜ൪߸͸ରԠ͍ͯ͠ͳ͍ ͜ͱ͕΄ͱΜͲͰ͢ʢ֦ுػೳ͕࢖͑Δ৔߹΋ ͋Δʣɽ
  56. 2JJUBͷهࣄʹ΋࢖ΘΕ͍ͯΔ https://qiita.com/tttamaki/private/8fd1ddc3a8cd1bd3d271

  57. (JU)VC͸਺ࣜඇରԠ https://gist.github.com/tttamaki/4723838f11abe43c6864349a6acd2159

  58. (JU)VC͸਺ࣜඇରԠ https://gist.github.com/tttamaki/4723838f11abe43c6864349a6acd2159

  59. +VQZUFS OPUFCPPLͰ΋࢖ΘΕΔ

  60. ͦΕͧΕͷه๏ͷղઆ https://guides.github.com/features/masterin g-markdown https://qiita.com/Qiita/items/c686397e4a0f4f11683d

  61. .BSLEPXOͷ୹ॴ nํݴ͕ଟ͍ • ϨϯμϥʹΑͬͯҧ͍͕͋Δ • ਺ࣜͷରԠͷ༗ແ • Πϯσϯτͷ਺ͷҧ͍ • 2͔4͔

    • https://github.com/commonmark/commonmark-spec/wiki/Markdown-Flavors
  62. SF4USVDUVSFE5FYUʢ345ʣ nMarkdownͱ͸ผͷϚʔΫΞοϓݴޠ • ํݴ͕ͳ͍Α͏ʹ౷Ұ͞Ε͍ͯΔ • ٕज़υΩϡϝϯτ༻ʢMarkdown͸web༻ʹ։ൃ͞Εͨʣ • HTMLɼLaTeXʢPDFʣɼʹ΋ม׵Մೳ • Markdown͸pandocΛ࢖͑͹ม׵͸ඞཁɼͰ΋׬ᘳͰ͸ͳ͍

    • github pagesͳͲͰ΋αϙʔτ͞Ε͍ͯΔ • DocstringɼSphinxͰ࢖ΘΕ͍ͯΔ nreStructuredText vs Markdown for documentation • https://www.zverovich.net/2016/06/16/rst-vs-markdown.html
  63. ؆୯ͳSF4USVDUVSFE5FYUจ๏ ============ RSTͷจ๏ ============ Ϧετ =============== * Օ৚ॻ͖ * ͜͏ͳΓ·͢

    * ΠϯσϯτΛ2ͭԼ͛Δͱ * Ϩϕϧ্͕͕Γ·͢ * Օ৚ॻ͖ * Օ৚ॻ͖ * Օ৚ॻ͖
  64. ؆୯ͳSF4USVDUVSFE5FYUจ๏ ίʔυ ========= ίʔυΛೖྗ͢Δ৔߹͸ҎԼͷΑ͏ͳίʔυϒ ϩοΫΛ࢖͍·͢ɽ .. code-block:: python def myfunc(a,

    b, c): a = b + c print(a)
  65. ؆୯ͳSF4USVDUVSFE5FYUจ๏ ਺ࣜ ========= ϨϯμϥʹΑͬͯ͸ :math:`y = f(x)` ͷ Α͏ͳLaTeX਺ࣜ΋ରԠ͍ͯ͠·͢ɽΠϯϥΠ ϯ͚ͩͰͳ͘ɼߦཱͯͷ਺ࣜ

    .. math:: y = ¥int_a^b f(x, t) dt ΋ରԠ͍ͯ͠·͢ɽ
  66. .BSLEPXOͱ345ͷ࢖͍෼͚ nMarkdown • ํݴ͸ଟ͍ • ਺ࣜ͸ରԠ͍ͯͨ͠Γ͍ͯ͠ͳ ͔ͬͨΓ • ֮͑ͨจ๏͕࢖͑ͳ͔ͬͨΓ •

    ༻్͸ଟ͍ • Qiita, GitHub, etc • Jupyter notebook • Ϩϯμϥʔ΍ϓϨϏϡʔΞ΋ଟ͍ • DoxygenͳΒMarkdown nRST • ౷Ұ͞Ε͍ͯΔ • ֮͑Δ·Ͱ͕গ͠େม • ਺ࣜ͸ରԠ͍ͯ͠ͳ͍ • SphinxଆͰରԠ • DocstringΛॻ͍ͯSphinxͳΒRST
  67. ͦͷଞͷ࿩୊

  68. 1BOEPD nςΩετίϯόʔλ • Markdown͔ΒRST΁ • RST͔ΒMarkdowns΁ nͦͷଞͷରԠϑΥʔϚοτ • HTML •

    LaTeX/PDF • Word • EPUBʢిࢠϒοΫܗࣜʣ • Jupyter notebook n஫ҙ • ೔ຊޠඇରԠͷ৔߹΋͋Δ https://pandoc.org
  69. 1BOEPDͷྫɿNE͔ΒIUNM΁ Markdown HTML ϒϥ΢βදࣔ ม׵ݩೖྗ ϑΝΠϧ໊ -oͰม׵ઌग़ྗ ϑΝΠϧ໊ࢦఆ -fͰม׵ݩͷ ϑΥʔϚοτ

    -tͰม׵ઌͷ ϑΥʔϚοτ
  70. 1BOEPDͷྫɿNE͔ΒEPDY΁ Markdown WordͰදࣔ ม׵ݩೖྗ ϑΝΠϧ໊ -oͰม׵ઌग़ྗ ϑΝΠϧ໊ࢦఆ -fͰม׵ݩͷ ϑΥʔϚοτ -tͰม׵ઌͷ

    ϑΥʔϚοτ
  71. https://readthedocs.org 3FBEUIF%PDT 3U% nSphinxͷϗεςΟϯάαʔ Ϗε • υΩϡϝϯτެ։ͷSaaS nGitHubͷϓϩδΣΫτʹ࿈ ܞͰ͖Δ •

    ྫ • https://github.com/se- nitech/12_01_sphinx/tree/ readthedoc • https://12-01- sphinx.readthedocs.io/ja/l atest/py-modindex.html
  72. None
  73. ՝୊ nSphinxͱDoxygenͰυΩϡϝϯτΛ࡞੒ͤΑ • εϥΠυͰ࢖ͬͨαϯϓϧΛଟগमਖ਼͢Δ͚ͩͰOK nจॻΛmarkdownͰ࡞੒ͤΑ • markdownϑΝΠϧΛpandocͰWordϑΝΠϧʹม׵ • ͦΕΛPDFʹม׵

  74. ૝ఆࢼݧ໰୊ nυΩϡϝϯςʔγϣϯͷॏཁੑΛઆ໌ͤΑ nྑ͍ίϝϯτͱѱ͍ίϝϯτ͸ͲͷΑ͏ͳ΋ͷ͔Λઆ໌ͤΑ nDocstringͱ͸ͲͷΑ͏ͳ΋ͷ͔Λ۩ମྫΛ༻͍ͯઆ໌ͤΑ nSphinx΍DoxygenͳͲͷπʔϧΛ࢖ͬͯυΩϡϝϯτΛ࡞੒͢Δར఺ Λड़΂Α nϚʔΫΞοϓݴޠͱ͸Կ͔ɼͲͷΑ͏ͳ΋ͷ͕͋Δͷ͔Λड़΂Α nmarkdownͷจ๏Λɼ۩ମྫΛ༻͍ͯઆ໌ͤΑ nreStructuredTextͷจ๏Λɼ۩ମྫΛ༻͍ͯઆ໌ͤΑ