pycharm에서 sphinx를 사용하여 문서 생성
7731 단어 Pycharm
주의
계산기에 익숙하지 않기 때문에 아마추어적으로 이상한 말을 하고 있을지도 모른다. 눈치채면 코멘트등에서 가르쳐 주시면 기쁘다.
introduction
나는 파이썬을 사용하여 프로그램을 작성할 때 pydoc 형식의 코멘트를 쓰고있다. 그렇다면 그것을 정리한 간단한 문서를 만들어 두고 싶다. 이미지로서는 다음과 같다.
개발 자체는 Pycharm을 이용하는 경우가 많기 때문에 Pycharm에서 문서를 생성할 때의 메모를 남겨두기로 했다.
톱 페이지
API에 대해 이것이 설명되어 있습니다.
코드도 날 수 있다
설정
사용한 코드, Pycharm은 다음과 같습니다.
* 이용 코드
* 이번 이용한 코드는 htps : // 기주 b. 코 m / 아오미 d로 / 바야시 그 p 치미 제 r 에 있는 베이즈 최적화 연습 코드. 코드에서 저서의 역량의 낮음을 볼 수 있다.
Pycharm을 이용해 이 코드를 쓰고 있다고 해서, 이에 관한 문서를 Sphinx로 생성하고 싶다.
나는 파이썬을 사용하여 프로그램을 작성할 때 pydoc 형식의 코멘트를 쓰고있다. 그렇다면 그것을 정리한 간단한 문서를 만들어 두고 싶다. 이미지로서는 다음과 같다.
개발 자체는 Pycharm을 이용하는 경우가 많기 때문에 Pycharm에서 문서를 생성할 때의 메모를 남겨두기로 했다.
톱 페이지
API에 대해 이것이 설명되어 있습니다.
코드도 날 수 있다
설정
사용한 코드, Pycharm은 다음과 같습니다.
* 이용 코드
* 이번 이용한 코드는 htps : // 기주 b. 코 m / 아오미 d로 / 바야시 그 p 치미 제 r 에 있는 베이즈 최적화 연습 코드. 코드에서 저서의 역량의 낮음을 볼 수 있다.
Pycharm을 이용해 이 코드를 쓰고 있다고 해서, 이에 관한 문서를 Sphinx로 생성하고 싶다.
방법
introduction에 쓰여진 것을 만드는 방법은 다음과 같습니다. 이하에 이 순서에 따른 경우의 수속을 써 둔다.
1. Pycharm에서 무언가 프로젝트 열기
2. Sphinx의 초기 설정하기
- Sphinx QuickStart로 전체 초기 설정
- conf.py 재작성
3. sphinx-apidoc에서 module 관계를 설명하는 rst 파일 만들기
4. make
1.Pycharm에서 무언가 프로젝트를 엽니다.
설명 불필요할지도 모른다. github에서 당겨 온 상술한 코드의 경우, 아래와 같은 상태가 되어 있다고 생각한다.
2.Sphinx의 초기 설정을 실시한다
Sphinx QuickStart로 전체 초기 설정
Pycharm의 "Tools"에서 Sphinx Quickstart를 누릅니다. 여기서 프로젝트 이름은 무엇으로 할 것인가, pydoc에서 자동 생성을 할 것인지 등을 설정한다. 누르면 Pycharm의 화면 아래쪽에 콘솔이 나오고 거기에서 대화식으로 상호 작용합니다. 아래와 같은 교환을 한다. 의미를 틀리게 하는 부분은 거의 없다고 생각하지만, autodoc의 건은 'y'라고 대답해 두지 않으면 나중에 손으로 설정 파일을 고쳐야 한다.
Welcome to the Sphinx 1.3.5 quickstart utility.
Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).
Enter the root path for documentation.
> Root path for the documentation [.]:
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]:
Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:
The project name will occur in several places in the built documentation.
> Project name: test project
> Author name(s): ########
Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1. If you don't need this dual structure,
just set both to the same value.
> Project version: 1.0
> Project release [1.0]: 1.0.0
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
http://sphinx-doc.org/config.html#confval-language.
> Project language [en]:
The file name suffix for source files. Commonly, this is either ".txt"
or ".rst". Only files with this suffix are considered documents.
> Source file suffix [.rst]:
One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:
Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]:
Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/n) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> pngmath: include math, rendered as PNG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]: y
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]: y
A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx:helmet_with_cross:-build
directly.
> Create Makefile? (y/n) [y]:
> Create Windows command file? (y/n) [y]: n
Creating file ./conf.py.
Creating file ./index.rst.
Creating file ./Makefile.
Finished: An initial directory structure has been created.
conf.py 재작성
autodoc 등의 기능은 확장 기능이지만, 이러한 파일은 대부분 프로젝트 디렉토리에는 없다.
그 경우에는 다음과 같이 한다.
# 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.
sys.path.insert(0, os.path.abspath('.'))
3. sphinx-apidoc에서 module 관계를 설명하는 rst 파일 만들기
터미널에서 sphinx-apidoc을 두드린다. 사용법은 다음과 같습니다.
sphinx-apidoc -f -o (生成物を置きたいディレクトリ) （ソースコードが入っているディレクトリ）
-f로 덮어쓰기를 허용하고 -o로 출력 디렉토리를 지정합니다. 성공하면 modules.rst 등이 만들어져야 한다.
게다가, 톱 페이지로부터 날 수 있도록(듯이), 아마 이미 작성되고 있을 index.rst 파일을 이하와 같이 편집한다.
Welcome to test project's documentation!
========================================
Contents:
.. toctree::
:maxdepth: 2
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
4. make한다.
터미널이라면 sphinx-apidoc을 두드린 것과 같은 장소에서,
make html
하면 된다. pycharm에서라면 run에서 실행할 수 있습니다. Run->Edit Configurations에서 아래와 같은 느낌으로 설정한다.
이렇게 하면 _build 이하에 일식이 놓이게 된다.
references
Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).
Enter the root path for documentation.
> Root path for the documentation [.]:
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]:
Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:
The project name will occur in several places in the built documentation.
> Project name: test project
> Author name(s): ########
Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1. If you don't need this dual structure,
just set both to the same value.
> Project version: 1.0
> Project release [1.0]: 1.0.0
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
http://sphinx-doc.org/config.html#confval-language.
> Project language [en]:
The file name suffix for source files. Commonly, this is either ".txt"
or ".rst". Only files with this suffix are considered documents.
> Source file suffix [.rst]:
One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:
Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]:
Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/n) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> pngmath: include math, rendered as PNG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]: y
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]: y
A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx:helmet_with_cross:-build
directly.
> Create Makefile? (y/n) [y]:
> Create Windows command file? (y/n) [y]: n
Creating file ./conf.py.
Creating file ./index.rst.
Creating file ./Makefile.
Finished: An initial directory structure has been created.
# 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.
sys.path.insert(0, os.path.abspath('.'))
sphinx-apidoc -f -o (生成物を置きたいディレクトリ) （ソースコードが入っているディレクトリ）
Welcome to test project's documentation!
========================================
Contents:
.. toctree::
:maxdepth: 2
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
make html
Reference
이 문제에 관하여(pycharm에서 sphinx를 사용하여 문서 생성), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://qiita.com/aomidro/items/33b2b840da9edf8a5c6a텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
좋은 웹페이지 즐겨찾기
