コピペで絶対動く。説明を妥協しない

# Using sphinx how to generate documents of python classes and functions

### Abstruct

Hello everyone it’s me candle. In this article I will explain how to make documents about classes and functions with Sphinx automatically.

### condition

I will explain it using Python 3, but I think that it will probably work with python 2 as well.

### Prepare test files

Create a main.py and dog.py.

touch main.py dog.py


Write this to the main.py

from dog import Dog

def main():
dog = Dog()
dog.show_name()

if __name__ == "__main__":
main()


Open the dog.py and write it.

class Dog(object):
def __init__(self, name="bob"):
self.name = name

def bark():
print("Bow Wow")

def show_name(self):
print(self.name)

def get_name(self):
return self.name

def set_time(self, name):
self.name = name


It’s ok.

### Install Sphinx

Sphinx is installed by pip.
Since we are using python 3, install it with pip3 command.

pip3 install Sphinx


We can use some sphinx commands as a global.
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart

### Setup Sphinx

Next we start to set up Sphinx.
Create a folder to place Sphinx’s files.

mkdir docs


This is the folder structure. __pycache__ is a python cache folder.

We setup Sphinx with a sphinx-quickstart command.
You pass the value where you want to expand the Sphinx files
After running this command, it starts to do interactive interactions.

sphinx-quickstart docs


Separate source and build directories (y/n) [n]:　is “n” of default
Name prefix for templates and static dir [_]: is “_” of default

Project name:

You give the name of your project. In this time we type “sphinx_dog”.

Author name(s):

Type your favorite name. I choose a name “alice”.

Project version []: If so, you specify the version. If not, just press the enter.
Project release []: If so, you specify the relese. If not, just press the enter.
Project language [en]:　Press the enter
Source file suffix [.rst]: is default
Name of your master document (without suffix) [index]: is default

All the questions below are default

> autodoc: automatically insert docstrings from modules (y/n) [n]:
> 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]:
> imgmath: include math, rendered as PNG or SVG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> 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]:
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]:

Create Makefile? (y/n) [y]:　is default.
Create Windows command file? (y/n) [y]: is default.

After finish settings, some files are created in the docs folder.

Setup is over.

### Automatic Document Creation Settings

If you do nothing, Sphinx won’t make a document from a code automatically.
So let’s start configuration.

Open a docs/conf.py

Change reference path of Sphinx

Describe the location of the python file to read.
First comment in the following part of conf.py.

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


Specify a path that is the parent folder.

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


Next, Read extensions which generates a document from docstring written in python code.

From

extensions = []


To

extensions = ['sphinx.ext.autodoc','sphinx.ext.viewcode']


sphinx.ext.autodoc automatically generates a document written in a docstring in the function etc.

“””
A dog will bark ‘Bow Wow’

Example::

from dog import Dog
dog = Dog()
dog.bark()

“””

sphinx.ext.viewcode will display a link to the source code at the function description.

Write the following code under it.

# Include Python objects as they appear in source files
# Default: alphabetically ('alphabetical')
autodoc_member_order = 'bysource'
# Default flags used by autodoc directives
autodoc_default_flags = ['members', 'show-inheritance']


Each detail properties are writtein in this post.
http://www.sphinx-doc.org/ja/stable/ext/autodoc.html

Next we decide the content to display in the sidebar.

From

# html_sidebars = {}


To

html_sidebars = {
'**': [
'relations.html',  # needs 'show_related': True theme option to display
'searchbox.html',
]
}


The setting of phinx is over.

### Display a link to each modules on the top page

Top page is index.rst. Open it and add “dog” to the toctree.

.. toctree::
:maxdepth: 2
:caption: Contents:

dog


### Create a document

In the sphinx_dog folder execute the command, an rst file is created from the python file.

sphinx-apidoc -f  -o ./docs .


Let’s create a html file as a document from rst file.

sphinx-build -b html ./docs ./docs/_build


Double-click docs/_build/index.html to open it in your browser.

It is a success if it can be displayed like this.

### Write descriptions in docstring for classes and functions

Now, you move to the page of the Dog class, the class name and function are only displayed.

Open the dog.py, add some sphinx descriptions.

class Dog(object):
"""
This is a very simple Dog class.
This class can change the name of a dog, get it, or let the dog bark.

:param name: Dog name, Default is *bob*
:type name: str

Example::

from dog import Dog
dog = Dog()
"""

def __init__(self, name="bob"):
self.name = name

def bark():
print("Bow Wow")

def show_name(self):
print(self.name)

def get_name(self):
return self.name

def set_time(self, name):
"""
It returns a Dog class' name value .

:param name: New Dog name
:type name: str
"""

self.name = name


After saving, execute the following again to update the document.

sphinx-build -b html ./docs ./docs/_build


An explanation is added in the page of the dog class.

### Document generation script

Since it is troublesome to run a command each time, we will create a python script.

touch make_docs.py


Write it.

import subprocess

def run():
cmd_api = "sphinx-apidoc -f -o ./docs ./"
cmd_doc = "sphinx-build -b html ./docs ./docs/_build"

for cmd in [cmd_api, cmd_doc]:
result = res = subprocess.Popen(cmd, shell=True, universal_newlines=False)
print(result)

if __name__ == '__main__':
run()


Create a document with the following command.

python3 make_docs.py


### Conclusion

sphinx ‘s autodoc is convenient, but its code gets lengthened.

http://docutils.sourceforge.net/docs/user/rst/quickref.html

This is a good sample.

https://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html

Abstract Hello everyoen it’s me candle. This time let’s make a delayed loading of images with react-lazyload. The problem of SPA is the delay at the time of initial loading. Among them, we feel that the site with many images is even late. Let’s try it. Condition Nothing Prepare If you have already developing react project, use it. But you don’t have yet or try to test. Generate it with this command. create-react-app imageloader-sample cd imageloader-sample We will prepare images for samples with Faker.js, so install it. yarn add faker Ready to develop. Make a sample code Open the src/App.js …

Tutorial to create a modal using react-modal

Abstract Hello everyone it’s me candle. In this time, let’s create a modal with react-modal. React-modal is a library which can create and handle a modal easily. But However, react-modal is not easy if you try to actually use it. it is necessary to incorporate state management, action, design etc. In this article, I will explain it like a tutorial and we will make a modal together. Condition You have a react knowledge. You installed create-react-app. Set up development env If you already have a some react project, you would use it. Otherwise, you don’t have a any project, please …

React Native slows down when debugging on Google Chrome

English 日本語 Abstract Hello everybody, It’s candle. This time, we will solve the problem that using simulator is going to slow down when debugging on the Google Chrome Anyway, It is solved in a simple way. we use Chromium instead of Google Chrome. Premise React development environment has been established

4 functions of scikit-learn preprocesses data such as machine learning

Abstract Hello every one this is candle. In this time we will prreprocess a data with scikit-learn which is machine learning library of python. We will use scikit-learn called With scikit-learn you can use what is called a converter, and you can convert the input data with fit_transform () method.Since there are many converters, I will introduce the following four converters that are often used in machine learning. Imputer StandardScaler MinMaxScaler OneHotEncorder Condition Python3 scikit-learn 0.19.1 For running sample code, you need numpy aside from these libs.

Tutorial How to use GSAP animation with React

Abstract Hello everyone it’s me candle. In this time we will use GSAP in React. The famous js library which can easily use animation is jQuery. However, it seems that compatibility between jQuery and React is bad. And there are no functions Also, as far as I know, React has no animation function that is easy to use(Yeah, Transition is). But, all times and places, it is rare case that animation is not necessary　when you have created a web service. There are many candidates when using animation with React. Of course, you can import only the necessary functions and use …

I work in the venture company as a CTO. I start to write program in University, first I learned java, C++ and PHP. In the company, I'm developing web services by Rails. I do like to automation.