(python) docstring, 문서화
docstring 작성 포맷
https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format
google style 은 다음과 같은데 타입 적는게 :가 아니라 괄호 안에 들어가서 마음에 안들고, 들여쓰기 때문에 가로축도 많이 차지하고, VSCode에서 힌트 팝업으로 보여줄 때도 bold나 글꼴 크기같은게 안예쁘게 들어간다.
1
2
3
4
5
Args:
path (str): 설명
Returns:
int: 설명
Sphinx와 잘 붙는건 reST 스타일인데, :param v1:
과 :type v1:
을 따로 적어주어야 한다는 점이 마음에 들지 않고 가독성도 썩 좋지 않은 것 같다. 가독성은 Numpydoc 스타일이 괜찮고, 그나마 제일 마음에 드는 스타일.
https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
sphinx
http://alifejon.blogspot.com/2016/02/sphinx-python-api.html
스핑크스에sphinx.ext.napoleon 플러그인을 추가하면 NumPy 스타일의 독스트링을 사용할 수 있음.
1. sphinx-quickstart # conf.py 및 기본 구조 생성
1
2
3
4
5
6
D:\Source\RAPTs\docs
λ sphinx-quickstart.exe
...
docs/source/conf.py 설정
conf.py conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
#!/usr/bin/env python3
## -\*- coding: utf-8 -\*-
#
## RAPT documentation build configuration file, created by
## sphinx-quickstart on Fri Oct 19 11:21:57 2018.
#
## This file is execfile()d with the current directory set to its
## containing dir.
#
## Note that not all possible configuration values are present in this
## autogenerated file.
#
## All configuration values have a default; values that are commented out
## serve to show the default.
## If extensions (or modules to document with autodoc) are in another directory,
## add these directories to sys.path here. If the directory is relative to the
## documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
## D:\Source\RAPTs\docs\source
sys.path.insert(0, os.path.abspath('../../RAPT'))
## -- General configuration ------------------------------------------------
## If your documentation needs a minimal Sphinx version, state it here.
#
## needs\_sphinx = '1.0'
## Add any Sphinx extension module names here, as strings. They can be
## extensions coming with Sphinx (named 'sphinx.ext.\*') or your custom
## ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon']
## Add any paths that contain templates here, relative to this directory.
templates\_path = ['\_templates']
from recommonmark.parser import CommonMarkParser
source\_parsers = {
'.md': CommonMarkParser,
}
## The suffix(es) of source filenames.
## You can specify multiple suffix as a list of string:
#
source\_suffix = ['.rst', '.md']
## The master toctree document.
master\_doc = 'index'
## General information about the project.
project = 'RAPT'
copyright = '2018, umbum, kangprog, awakening95, domoor'
author = 'umbum, kangprog, awakening95, domoor'
## The version info for the project you're documenting, acts as replacement for
## |version| and |release|, also used in various other places throughout the
## built documents.
#
## The short X.Y version.
version = '0.1'
## The full version, including alpha/beta/rc tags.
release = '0.1'
## The language for content autogenerated by Sphinx. Refer to documentation
## for a list of supported languages.
#
## This is also used if you do content translation via gettext catalogs.
## Usually you set "language" from the command line for these cases.
language = None
## List of patterns, relative to source directory, that match files and
## directories to ignore when looking for source files.
## This patterns also effect to html\_static\_path and html\_extra\_path
exclude\_patterns = []
## The name of the Pygments (syntax highlighting) style to use.
pygments\_style = 'sphinx'
## If true, `todo` and `todoList` produce output, else they produce nothing.
todo\_include\_todos = True
## -- Options for HTML output ----------------------------------------------
## The theme to use for HTML and HTML Help pages. See the documentation for
## a list of builtin themes.
#
html\_theme = 'sphinx\_rtd\_theme'
## html\_theme = 'alabaster'
## Theme options are theme-specific and customize the look and feel of a theme
## further. For a list of options available for each theme, see the
## documentation.
#
## html\_theme\_options = {}
## Add any paths that contain custom static files (such as style sheets) here,
## relative to this directory. They are copied after the builtin static files,
## so a file named "default.css" will overwrite the builtin "default.css".
html\_static\_path = ['\_static']
## Custom sidebar templates, must be a dictionary that maps document names
## to template names.
#
## This is required for the alabaster theme
## refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html\_sidebars = {
'\*\*': [
'relations.html', # needs 'show\_related': True theme option to display
'searchbox.html',
]
}
## -- Options for HTMLHelp output ------------------------------------------
## Output file base name for HTML help builder.
htmlhelp\_basename = 'RAPTdoc'
## -- Options for LaTeX output ---------------------------------------------
latex\_elements = {
## The paper size ('letterpaper' or 'a4paper').
#
## 'papersize': 'letterpaper',
## The font size ('10pt', '11pt' or '12pt').
#
## 'pointsize': '10pt',
## Additional stuff for the LaTeX preamble.
#
## 'preamble': '',
## Latex figure (float) alignment
#
## 'figure\_align': 'htbp',
}
## Grouping the document tree into LaTeX files. List of tuples
## (source start file, target name, title,
## author, documentclass [howto, manual, or own class]).
latex\_documents = [
(master\_doc, 'RAPT.tex', 'RAPT Documentation',
'umbum, kangprog, awakening95, domoor', 'manual'),
]
## -- Options for manual page output ---------------------------------------
## One entry per manual page. List of tuples
## (source start file, name, description, authors, manual section).
man\_pages = [
(master\_doc, 'rapt', 'RAPT Documentation',
[author], 1)
]
## -- Options for Texinfo output -------------------------------------------
## Grouping the document tree into Texinfo files. List of tuples
## (source start file, target name, title, author,
## dir menu entry, description, category)
texinfo\_documents = [
(master\_doc, 'RAPT', 'RAPT Documentation',
author, 'RAPT', 'One line description of project.',
'Miscellaneous'),
]
## Example configuration for intersphinx: refer to the Python standard library.
intersphinx\_mapping = {'https://docs.python.org/': None}
conf.py
sphinx에서 reST말고 .md도 파싱하기
https://github.com/rtfd/recommonmark
2. sphinx-apidoc # .rst 파일 생성
1
2
3
4
5
D:\Source\RAPTs
λ sphinx-apidoc.exe -f -o docs/source RAPT
쓸만한 옵션은 -f, -o, -e
sidebar 설정
source/index.rst
에서 사이드바에 나타낼 디렉토리 이름 추가
1
2
3
4
5
6
.. toctree::
:maxdepth: 2
:caption: Contents:
**src**
3. make.bat html
1
2
3
4
5
D:\Source\RAPTs\docs
λ make.bat html
This post is licensed under CC BY 4.0 by the author.