33
44# You can set these variables from the command line.
55SPHINXOPTS =
6- SPHINXBUILD = python -m sphinx
6+ SPHINXBUILD = python3 -m sphinx
77SOURCEDIR = .
88BUILDDIR = _build
99
@@ -18,21 +18,15 @@ help:
1818# For sphinx-apidoc the first positional path is the module to document
1919# then all the other ones are paths to exclude for the doc generation
2020% : Makefile
21- sed -i ' s/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/* .py
22- sed -i ' s/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/* /* .py
23- sed -i ' s/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/* /* /* .py
24- sed -i ' s/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/* /* /* /* .py
21+ # Copy _plotly_utils file so that they appear in the API doc
2522 cp ../../packages/python/plotly/_plotly_utils/colors/sequential.py ../../packages/python/plotly/_plotly_utils/colors/diverging.py ../../packages/python/plotly/_plotly_utils/colors/qualitative.py ../../packages/python/plotly/_plotly_utils/colors/cyclical.py ../../packages/python/plotly/_plotly_utils/colors/colorbrewer.py ../../packages/python/plotly/_plotly_utils/colors/carto.py ../../packages/python/plotly/_plotly_utils/colors/cmocean.py ../../packages/python/plotly/plotly/colors
2623 cp ../../packages/python/plotly/_plotly_utils/colors/sequential.py ../../packages/python/plotly/_plotly_utils/colors/diverging.py ../../packages/python/plotly/_plotly_utils/colors/qualitative.py ../../packages/python/plotly/_plotly_utils/colors/cyclical.py ../../packages/python/plotly/_plotly_utils/colors/colorbrewer.py ../../packages/python/plotly/_plotly_utils/colors/carto.py ../../packages/python/plotly/_plotly_utils/colors/cmocean.py ../../packages/python/plotly/plotly/express/colors
24+ # Run sphinx-apidoc script to create hierarchy of rst files to generate
25+ # docstrings. The first path is the one to process, the following ones
26+ # are excluded from the search.
2727 sphinx-apidoc -M -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api
28+ # Run sphinx-build to build html pages from the rst pages
2829 @$(SPHINXBUILD ) -M $@ " $( SOURCEDIR) " " $( BUILDDIR) " $(SPHINXOPTS ) $(O )
29- git checkout -- ../../packages/python/plotly/plotly/graph_objs
30+ # Remove files which were added only for docstring generation
3031 rm ../../packages/python/plotly/plotly/colors/diverging.py ../../packages/python/plotly/plotly/colors/sequential.py ../../packages/python/plotly/plotly/colors/qualitative.py ../../packages/python/plotly/plotly/colors/cyclical.py ../../packages/python/plotly/plotly/colors/colorbrewer.py ../../packages/python/plotly/plotly/colors/carto.py ../../packages/python/plotly/plotly/colors/cmocean.py
3132 rm ../../packages/python/plotly/plotly/express/colors/diverging.py ../../packages/python/plotly/plotly/express/colors/sequential.py ../../packages/python/plotly/plotly/express/colors/qualitative.py ../../packages/python/plotly/plotly/express/colors/cyclical.py ../../packages/python/plotly/plotly/express/colors/colorbrewer.py ../../packages/python/plotly/plotly/express/colors/carto.py ../../packages/python/plotly/plotly/express/colors/cmocean.py
32- rename ' s/graph_objs/graph_objects/' _build/html/* .html _build/html/generated/* .html
33- mv _build/html/generated/plotly.graph_objs.html _build/html/generated/plotly.graph_objects.html
34- sed -i ' s/graph_objs/graph_objects/g' _build/html/* .html
35- sed -i ' s/graph_objs/graph_objects/g' _build/html/* .inv
36- sed -i ' s/graph_objs/graph_objects/g' _build/html/* .js
37- sed -i ' s/graph_objs/graph_objects/g' _build/html/generated/* .html
38- sed -i ' s/graph_objs/graph_objects/g' _build/html/generated/generated/* .html
0 commit comments