端端舝

玉平亙丟件玄及輥適腔蜊囡
Sphinx毛妏中卅互日
絁宒頗扦失皿玄禾永玉氾弁瓦市伙戊件氾件汁犯奴伊弁正奈
搴ぃ跁珨檔
? aptpod Inc. All Rights Reserved. 1
2 0 2 3 / 0 7 / 1 3

赻撩畿賡
2
? aptpod Inc. All Rights Reserved.
? 垀扽
? 絁宒頗扦失皿玄禾永玉 https://www.aptpod.co.jp/
? 童絞
? 氾弁瓦市伙戊件氾件汁犯奴伊弁正奈
? 統蕉氾永弁皮伕弘�岈: ☆夫午曰玉平亙丟件玄童絞★ *及帊岈
https://tech.aptpod.co.jp/entry/2021/12/20/070000
? �窃
? 2001-2008 穴瓦亙失伙秶釬頗扦嗣晟惤秶釬戊奈犯奴生奈正奈
? 2010-2020 丟奈市奈赽頗扦穴瓦亙失伙秶釬窒嬡仿奶正奈﹜犯奴伊弁正奈
? 2020- 政�
* ☆夫午曰ロ扑旦★卞卅冗日尹凶手及匹允﹝

仇及逃桶及囀⺍午打奈伙
? aptpod, Inc. All Rights Reserved. 3
? 囀⺍
? Sphinx毛妏勻凶玉平亙丟件玄秶釬岈瞰及畿賡
? 打奈伙
? ☆Sphinx勻化仇丹中丹手及卅氏分★午佷勻化中凶分仁
? ☆嗣辻夔匹⺥�匹中欠中欠匹五公丹分卅★午佷勻化中凶分仁
? ☆赻煦及耋撿眊卞手⻌木化云仇丹井卅★午佷勻化中凶分仁

醴棒
? ゴ离五: 失皿玄禾永玉卞勾中化
? 1. Sphinx勻化升氏卅手及ˋ
? 2. Sphinx毛妸蚚仄凶燴蚕
? 3. Sphinx及⺥�今毛魂蚚仄卅互日市旦正穴奶朮?蜊囡
? 引午戶

失皿玄禾永玉卞勾中化

失皿玄禾永玉卞勾中化
? ☆詢螿僅犯奈正★毛☆腴綈晊匹★�冞允月IoT及帊瞎心毛勾仁勻化中引允
? 犯奈正龰腕犯田奶旦井日﹜扔奈田奈末白玄它尼失﹜失皿伉弗奈扑亦件引匹
? 犯田奶旦午扔奈田奈及嶲毛勾卅什黃赻皿伕玄戊伙ㄗiSCPㄘ
? 褫�趙母永扑亙示奈玉手

失皿玄禾永玉及庨ⅲ互灍政允月宴𦲀IoT扑瓜伉左

瞰: 赻��井日犯奈正毛龰腕
https://www.youtube.com/watch?v=vybSwUoDMcY&t=5s

? 甩奈玉它尼失穴瓦亙失伙
釬勻化中月玉平亙丟件玄公及1
PDF
∥ 仇木日反允屯化Sphinx匹秶釬

? aptpod, Inc. All Rights Reserved. 1 0
? 它尼皮失皿伉弗奈扑亦件及紱釬穴瓦亙失伙
PDF
HTML

? 嶱逃氪砃仃布奶玉
PDF
HTML

1. Sphinx勻化升氏卅手及ˋ

Sphinx午反
? documentation generator*1
? reStructuredText�楊匹𤩸中凶手及*2毛PDF支HTML倛宒匹堤薯允
月汁奈伙
*1 https://www.sphinx-doc.org/ja/master/usage/quickstart.html
*2 MyST毛奶件旦玄奈伙允月午Markdown及瞳蚚手褫夔
賒砉
ㄗpng坻ㄘ
PDF
HTML
LaTeX
偞隅
conf.py
氾平旦玄
ㄗreStructuredTextㄘ
Sphinx皿伕斥尼弁玄ㄗ犯奴伊弁玄伉ㄘ

reStructuredTextㄗSphinx蚚ㄘ
? aptpod Inc. All Rights Reserved. 1 4
梒伊矛伙
========
仇木反掛恅匹允﹝ ``inline code`` 匹允﹝
�伊矛伙ㄗ梒及狟及伊矛伙ㄘ
--------------------------
仇木反掛恅匹允﹝
�伊矛伙ㄗ�及狟及伊矛伙ㄘ
~~~~~~~~~~~~~~~~~~~~~~~~~~
仇木反掛恅匹允﹝
�堤仄午掛恅
衵�反HTML卞劐𡥼仄凶�磁及珨瞰匹允﹝
偞隅卞方勻化�井仃反�卅曰引允﹝

* 楓瘍卅仄伉旦玄
1. 楓瘍葆五伉旦玄
伉旦玄

.. figure:: images/sample.png
�及扔件皿伙
�

.. code-block:: json
{
"key1": 1,
"key2": 2
}
戊奈玉皮伕永弁

.. list-table::
:widths: 1 2 2
:header-rows: 1
* - 蹈仿矛伙
- 蹈仿矛伙
- 蹈仿矛伙
* - 本伙1-1
- 本伙1-2
- 本伙1-3
* - 本伙2-1
- 本伙2-2
- 本伙2-3
桶及桶政源楊反坻卞手丐曰引允互﹜仇及
☆list-table★毛珨楓方仁妏勻化中引允﹝
桶ㄗlist-table及�磁ㄘ

.. note::
仇及窒煦反☆蛁�★卞卅曰引允﹝
.. important::
仇及窒煦反☆笭猁★卞卅曰引允﹝
.. warning::
仇及窒煦反☆劑豢★卞卅曰引允﹝
蛁�﹜劑豢脹ㄗadmonitionㄘ

奶件旦玄奈伙及源楊卞勾中化反﹜
:ref:`installation` 毛統桽仄化仁分今中﹝
.. _installation:
奶件旦玄奈伙
----------------
奶件旦玄奈伙反仇及方丹卞俴中引允﹝
眈誑統桽ㄗ伉件弁ㄘ

2. Sphinx毛妸蚚仄凶燴蚕

Sphinx毛妸蚚仄凶燴蚕 1
? 五木中卅゜掛惤PDF互釬木月ㄗLaTeX磊蚕ㄘ

? 楹偈伐奈弁白伕奈卞�𡛟
賒砉
ㄗpng坻ㄘ
PDF
HTML
LaTeX
偞隅
conf.py
゜掛惤氾平旦玄
゜荎�偈PO白央奶伙
ㄗGettext POㄘ
゜掛惤↙荎惤及�磁

? 辻夔��支ロ�互頄蜓
? 辻夔��
? 氾奈穴ㄗHTML堤薯及氾件皿伊奈玄ㄘ
? 妏中源卞勾中化及ロ�

妏中源卞勾中化及ロ�
? 鼠宒玉平亙丟件玄
? https://www.sphinx-doc.org/ja/
? 𤩸戮◇Sphinx毛反元戶方丹◆
? https://www.oreilly.co.jp/books/9784873119830/
? 生永玄奻卞手ロ�反頄蜓
? Stack Overflow匹 [python-sphinx]正弘互葆中凶斮�反3600眕奻

Sphinx匹釬傖仄凶磐彆
PDF

Sphinx匹釬傖仄凶磐彆
HTML

3. Sphinx及⺥�今毛魂蚚仄卅互日
市旦正穴奶朮?蜊囡

蜊囡仄化五凶仇午及丹切中仁勾井毛仍畿賡
? A. PDF旦正奶伙及市旦正穴奶朮
? B. HTML趙
? C. 𨈘坰巨件斥件Meilisearch及爀⻌ㄗHTML蚚ㄘ
Sphinx卞反﹜仇木眕俋卞手晞瞳卅辻夔反凶仁今氏丐曰引允仄﹜肮�及仇午毛灍政允月凶
戶及手勻午謎中源楊手丐月井手仄木引六氏﹝
仇仇匹畿賡允月源楊互允屯化匹反卅中午中丹仇午毛仍賸創仁分今中﹝

A. PDF堤薯及市旦正穴奶朮
? 桶�
? 目永母奈﹜白永正奈
? 醴棒及旦正奶伙
? 梒?�?�正奶玄伙及旦正奶伙
? 劑豢?蛁砩卅升及�心及旦正奶伙

市旦正穴奶朮及⻌曰諳偞隅白央奶伙conf.py
賒砉
ㄗpng坻ㄘ
PDF
LaTeX
偞隅
conf.py
氾平旦玄
HTML

偞隅白央奶伙conf.py
# -- Project information -----------
project = '氾旦玄玉平亙丟件玄'
copyright = '2023, my name'
author = 'my name'
release = 'v1.0'
# -- General configuration ----------
extensions = []
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
language = 'ja'
# -- Options for HTML output ---------
html_theme = 'alabaster'
html_static_path = ['_static']
...眕狟謹

PDF堤薯及市旦正穴奶朮
? Sphinx匹由仿丟奈正奈互蚚砩今木化中月手及反公木毛劐載
? 凶分仄﹜偞隅褫夔卅由仿丟奈正奈反屾卅中
瞰ㄩ
latex_show_pagerefs = True
偞隅白央奶伙conf.py卞眕狟毛袚樓

PDF堤薯及市旦正穴奶朮
? latex_elements及preamble卞LaTeX及戊奈玉毛𤩸仁
latex_elements = {
'preamble': '<仇仇卞𤩸中凶手及反﹜LaTeX皿伉失件皮伙午仄化堤薯今木月>'
}
ㄗ引凶反﹜俋窒白央奶伙卞𤩸中化掂心煋引六月方丹卞偞隅ㄘ

瞰1: 梒楓瘍及市旦正穴奶朮

? latex_elements及preamble卞LaTeX及戊奈玉毛𤩸仁
latex_elements = {
'preamble': r'''
renewcommand{prechaptername}{}
renewcommand{postchaptername}{}
'''
}

瞰2: PDF桶�及市旦正穴奶朮

桶�及笢旯
newcommand{sphinxmaketitle}{%
letsphinxrestorepageanchorsettingrelax
ifHy@pageanchordefsphinxrestorepageanchorsetting{Hy@pageanchortrue}fi
hypersetup{pageanchor=false}% avoid duplicate destination warnings
begin{titlepage}%
letfootnotesizesmall
letfootnoterulerelax
noindentrule{textwidth}{1pt}par
begingroup % for PDF information dictionary
defendgraf{ }defand{& }%
pdfstringdefDisableCommands{def{, }}% overwrite hyperref setup
hypersetup{pdfauthor={@author}, pdftitle={@title}}%
...適仁
Sphinx卞葆扽及LaTeX戊穴件玉☆sphinxmaketitle★
ㄗ犯白巧伙玄分午仇及戊穴件玉互妏歹木月午中丹仇午互Sphinx及玉平亙丟件玄卞𤩸中化丐
曰引允ㄘ

latex_elements = {
'preamble': r'''
makeatletter
newcommand{mysphinxmaketitle}{%
letsphinxrestorepageanchorsettingrelax
ifHy@pageanchordefsphinxrestorepageanchorsetting{Hy@pageanchortrue}fi
hypersetup{pageanchor=false}% avoid duplicate destination warnings
begin{titlepage}%
letfootnotesizesmall
letfootnoterulerelax
...吽謹...
}
makeatother
''',
'maketitle': r'mysphinxmaketitle'
}
桶�釬傖媆卞反奻�戊穴件玉毛妏丹方丹Sphinx卞硌尨
陔仄中桶�蚚戊穴件玉毛隅膽仄化LaTeX皿伉失件皮伙卞⻌木月

咡心及PDF旦正奶伙卞
Wordㄗ綎�及唳ㄘ Sphinx

LaTeX及岍賜
? 云允允戶𤩸戮

B. HTML趙
? 手午手午Sphinx反﹜HTML﹜PDF﹜ePub卅升今引介引卅堤薯互匹五月
? 價掛腔卞反﹜HTML堤薯允月戊穴件玉(make html)毛灍俴允月分仃匹
方中

妏蚚氾奈穴
? Read the Docs Sphinx Theme

妏蚚氾奈穴
? PyData Sphinx Theme

恚杅皿伕斥尼弁玄毛緙磁
? 中仁勾井及�赽分勻凶手及毛1勾及扔奶玄卞緙磁
? 公及丹尹匹﹜恚杅及PDF煦�午仄化堤薯允月方丹偞隅
Sphinx
Project A
緙磁仄凶Sphinx Project
Sphinx
Project B
Sphinx
Project C
失皿伉A掊隴𤩸
PDF
失皿伉B掊隴𤩸
PDF
失皿伉C掊隴𤩸
PDF HTML
失皿伉A掊隴𤩸
PDF
失皿伉B掊隴𤩸
PDF
失皿伉C掊隴𤩸
PDF

1勾及皿伕斥尼弁玄匹恚杅及PDF毛堤薯允月
latex_documents = [
# (PDF堤薯�砓及跪玉平亙丟件玄root, LaTeX白央奶伙靡, ..眕狟謹)
('app-a/index', 'app-a.tex', ...),
('app-b/index', 'app-b.tex', ...),
('app-c/index', 'app-c.tex', ...),
]

正皮及桶政
? sphinx-tabs午中丹��
? 奶件旦玄奈伙
? 偞隅白央奶伙conf.py卞 extensions = ['sphinx_tabs.tabs'] 毛硌隅
.. tabs::
.. tab:: Go
皿伕斥尼弁玄伙奈玄卞化眕狟及...
.. tab:: Python
.....
.. tab:: Rust
.....

戊奈玉皮伕永弁及戊疋奈示正件
? sphinx-copybutton午中丹��
? 奶件旦玄奈伙
? 偞隅白央奶伙conf.py卞 extensions = ['sphinx_copybutton'] 毛硌隅

Google失瓜伉氾奴弁旦爀⻌
Read the Docs Sphinx Theme支﹜PyData Sphinx Theme匹反﹜偞
隅白央奶伙conf.py卞Google失瓜伉氾奴弁旦ID毛偞隅允月分仃
html_theme_options = {
'analytics_id': 'G-XXXXXXXXXX'
}
偞隅白央奶伙conf.py ㄗ Read the Docs Sphinx Theme及�磁ㄘ

C. 𨈘坰巨件斥件Meilisearch及爀⻌ㄗHTML蚚ㄘ
? Meilisearch午中丹�恅𨈘坰巨件斥件毛爀⻌
統蕉: V今氏互鼠嶱今木化中月�岈
https://voluntas.medium.com/左件仿奶件玉平亙丟件玄午゜掛惤�恅𨈘坰-30cc38d7b1c3

Meilisearch毛妏丹凶戶及𨃨�1
? �蚚汁奈伙匹玉平亙丟件玄毛旦弁伊奶疋件弘仄化﹜匹五凶奶件犯永弁旦
毛Meilisearch扔奈田奈卞冞月
Meilisearch扔奈田奈
docs-scraper
ㄗMeilisearch及
�蚚旦弁伊奶疋件弘汁奈伙ㄘ
奶件犯永弁旦毛
失永皿伕奈玉
矢奈斥毛龰腕

Meilisearch毛妏丹凶戶及𨃨�2
? Sphinx及HTML氾奈穴毛市旦正穴奶朮允月
? 𨈘坰示永弁旦毛﹜Meilisearch互枑鼎允月 docs-searchbar.js
(https://github.com/meilisearch/docs-searchbar.js) 卞船仄杸尹月
? ゴ矢奈斥及忒�匹釬傖仄凶奶件犯永弁旦毛妏蚚允月方丹卞硌隅允月
Meilisearch扔奈田奈
Sphinx氾奈穴及卅井匹﹜
𨈘坰示永弁旦及窒煦毛
船仄杸尹
𨈘坰弁巨伉
磐彆

⺥�匹丐月午中丹仇午
? 市旦正穴奶朮互褫夔卅�垀互中仁勾手丐月
? 偞隅白央奶伙conf.py匹及偞隅
? 辻夔��及瞳蚚
? (HTML) 氾奈穴及珨窒毛离五𡥼尹
? (HTML) CSS袚樓掂心煋心
? (PDF) LaTeX戊奈玉及袚樓ㄗ戊穴件玉婬隅膽卅升ㄘ
? 卅升卅升...

市旦正穴奶朮ロ�及⻌曰諳
? 偞隅
https://www.sphinx-doc.org/ja/master/usage/configuration.html

踏摽及掝觳午仄化蕉尹化中月仇午
? 它尼皮扔奶玄午仄化瞳蚚仄支允中倛卞�婖毛淕燴
? HTML矢奈斥及旦正奶伙及蜊囡
? TMSㄗ楹偈穴生奈斥丟件玄扑旦氾丞ㄘ及瞳蚚

引午戶

引午戶
? Sphinx反午化手晞瞳
? PDF毛ㄗ手ㄘ釬傖仄凶中�磁反杻卞﹝
? Sphinx反嗣辻夔
? ヽ渾卞𡛟尹化仁木月﹝
? Sphinx反⺥�
? 偞隅支市旦正穴奶朮互褫夔卅窒煦互中欠中欠卅午仇欠卞蚚砩今木化中月及匹﹜
屾仄內勾秶釬昜毛蜊囡仄化中仁及卞手砃中化中月﹝

端端舝

玉平亙丟件玄及輥適腔蜊囡求釦梯堯勳紳單毛妏中卅互日

Recommended

More Related Content

What's hot (20)

Similar to 玉平亙丟件玄及輥適腔蜊囡求釦梯堯勳紳單毛妏中卅互日 (20)

Recently uploaded (15)

玉平亙丟件玄及輥適腔蜊囡求釦梯堯勳紳單毛妏中卅互日