Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/inureyes/rest-sphinx-example

Example of sphinx-reST documentation procedure
https://github.com/inureyes/rest-sphinx-example

Last synced: 6 days ago
JSON representation

Example of sphinx-reST documentation procedure

Awesome Lists containing this project

README 

        
# rest-sphinx-example

Example of sphinx-reST documentation procedure



## 상세



 1. sphinx를 설치합니다.

 2. 소스 프로그램이 있는 디렉토리로 이동합니다.

 3. sphinx-quickstart 를 실행합니다. 익스텐션을 설치할 때 `autodoc` 은 꼭 `y`를 눌러줍니다.

 ```

 ➜  rest-sphinx-example (master) ✗ sphinx-quickstart

 Welcome to the Sphinx 1.4.8 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 [.]: ./docs



 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: Game

 > Author name(s): Jeongkyu Shin



 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: 0.1

 > Project release [0.1]: 0.1



 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]: y

 > intersphinx: link between Sphinx documentation of different projects (y/n) [n]: y

 > todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: y

 > coverage: checks for documentation coverage (y/n) [n]: y

 > imgmath: include math, rendered as PNG or SVG images (y/n) [n]: n

 > mathjax: include math, rendered in the browser by MathJax (y/n) [n]: n

 > ifconfig: conditional inclusion of content based on config values (y/n) [n]: n

 > viewcode: include links to the source code of documented Python objects (y/n) [n]: n

 > githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]: n



 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-build

 directly.

 > Create Makefile? (y/n) [y]: y

 > Create Windows command file? (y/n) [y]: y



 Creating file ./docs/conf.py.

 Creating file ./docs/index.rst.

 Creating file ./docs/Makefile.

 Creating file ./docs/make.bat.



 Finished: An initial directory structure has been created.



 You should now populate your master file ./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.

 ```

 4. sphinx-apidoc을 실행해서 문서로부터 reST 문서를 추출합니다.

`sphinx-apidoc -M -l -o ./docs ./`

 5. docs 디렉토리로 이동한 후, conf.py 파일을 열어 앞부분에 소스파일의 경로를 추가합니다.

  * Python 3의 경우 :

```

# import os

import sys, os, pathlib

sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))

```

  * Python 2의 경우 :

```

import os, sys

sys.path.insert(0, os.path.abspath('.'))

sys.path.insert(0, os.path.abspath('..'))

```

 6. docs/index.rst를 열어 내 코드에서 생성된 reST 문서 (`game.rst`)를 참조하도록 수정합니다. 

```

    :maxdepth: 2



    game

```

 7. docs 디렉토리에서 컴파일을 통해 문서를 만듭니다.

`make html`

 8. 최종 결과물은 docs/_build/html 아래에 있습니다.