Commit 9de9c17f authored by narugo1992's avatar narugo1992
Browse files

dev(narugo): add operate docs

parent 19806dc2

docs/Makefile

+2 −1
Original line number Diff line number Diff line
@@ -28,7 +28,8 @@ help: 
contents:

	@$(ALL) build

build: html

html: contents

#html: contents

html:

	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

	@touch "$(BUILDDIR)/html/.nojekyll"

prod:

docs/source/api_doc/operate/align.rst

0 → 100644
+14 −0
Original line number Diff line number Diff line 
imgutils.operate.align

========================



.. currentmodule:: imgutils.operate.align



.. automodule:: imgutils.operate.align





align_maxsize

---------------------------



.. autofunction:: align_maxsize

docs/source/api_doc/operate/censor.rst

0 → 100644
+62 −0
Original line number Diff line number Diff line 
imgutils.operate.censor\_

===============================



.. currentmodule:: imgutils.operate.censor_



.. automodule:: imgutils.operate.censor_







censor_areas

--------------------------------------------



.. autofunction:: censor_areas







censor

--------------------------------------------



.. autofunction:: censor







BaseCensor

--------------------------------------------



.. autoclass:: BaseCensor

    :members:







ColorCensor

--------------------------------------------



.. autoclass:: ColorCensor

    :members:







BlurCensor

--------------------------------------------



.. autoclass:: BlurCensor

    :members:







PixelateCensor

--------------------------------------------



.. autoclass:: PixelateCensor

    :members:







register_censor_method

--------------------------------------------



.. autofunction:: register_censor_method

docs/source/api_doc/operate/imgcensor.rst

0 → 100644
+16 −0
Original line number Diff line number Diff line 
imgutils.operate.imgcensor

=======================================



.. currentmodule:: imgutils.operate.imgcensor



.. automodule:: imgutils.operate.imgcensor





ImageBasedCensor

--------------------------------------------



.. autoclass:: ImageBasedCensor

    :members:

docs/source/api_doc/operate/index.rst

0 → 100644
+16 −0
Original line number Diff line number Diff line 
imgutils.operate

========================



.. currentmodule:: imgutils.operate



.. automodule:: imgutils.operate





.. toctree::

    :maxdepth: 3



    align

    censor

    imgcensor

    squeeze