py-suruga / pycon-jp-2020-tutorial

PyCon JP 2020 チュートリアルで利用する資料です
MIT License
10 stars 4 forks source link

チュートリアルのドキュメントをtutorial_docsに記載:sphinxで作成 #8

Closed hrsano645 closed 4 years ago

hrsano645 commented 4 years ago

必要なドキュメントは issue #5 の各項目に、参加前準備用も必要

hrsano645 commented 4 years ago

sphinxのプロジェクト生成時のログ

PS C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial> sphinx-quickstart
Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Selected root path: .

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: 
[Interrupted.]
PS C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial> cd .\tutorial_docs\
PS C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial\tutorial_docs> sphinx-quickstart.exe
Welcome to the Sphinx 3.1.2 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Selected root path: .

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: n

The project name will occur in several places in the built documentation.
> Project name: pycon-jp-2020-tutorial-development-slackbot
> Author name(s): Py-Suruga, Unagi-py, Hiroshi sano
> Project release []: 2020.07.24

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.

For a list of supported codes, see
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
> Project language [en]: ja

Creating file C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial\tutorial_docs\conf.py.  
Creating file C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial\tutorial_docs\index.rst.
Creating file C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial\tutorial_docs\Makefile. 
Creating file C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial\tutorial_docs\make.bat. 

Finished: An initial directory structure has been created.

You should now populate your master file C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial\tutorial_docs\index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

PS C:\Users\hiroshi\Documents\workspace\personal\pycon-jp-2020-tutorial\tutorial_docs> 
hrsano645 commented 4 years ago

一通りのファイルを用意できたので、詳細を詰めていく。

hrsano645 commented 4 years ago

注釈的な情報を乗せたいときのディレクティブ

https://sphinx-users.jp/gettingstarted/directives.html#id10

noteを使えばよさそう

hrsano645 commented 4 years ago

todo ディレクティブも利用して、TODO管理しておく

https://www.sphinx-doc.org/ja/master/usage/extensions/todo.html

hrsano645 commented 4 years ago

ここのPRでTODOすべて潰せたので、一通りの必要なものを用意できたとしてissueクローズです。 https://github.com/py-suruga/pycon-jp-2020-tutorial/pull/28