Skip to content

Apigen recursive #2243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Mar 11, 2020
Merged

Apigen recursive #2243

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
95b6e69
using sphinx-apidoc for generating the hierarchy of doc pages
emmanuelle Jan 16, 2020
dfd842a
playing with templates
emmanuelle Jan 16, 2020
7f9df2d
autodoc for sphinx
emmanuelle Mar 9, 2020
a583e88
blacken
emmanuelle Mar 9, 2020
b59f5bd
Merge branch 'master' into apigen-recursive
emmanuelle Mar 9, 2020
8e7fbc4
also modified property functions
emmanuelle Mar 10, 2020
97b0e4a
changed :py:class: to :class:
emmanuelle Mar 10, 2020
801f7d3
blacken
emmanuelle Mar 10, 2020
c22ecf4
revert changes to package-lock
emmanuelle Mar 10, 2020
08f323a
some fixes
emmanuelle Mar 11, 2020
52a4174
fix
emmanuelle Mar 11, 2020
fa9bec0
removed module from trace page
emmanuelle Mar 11, 2020
aa5f026
revert template change
emmanuelle Mar 11, 2020
f139b7d
title in template
emmanuelle Mar 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ jobs:
cd ../../../doc
fi
echo 'export PATH="/home/circleci/project/doc/node_modules/.bin:$PATH"' >> $BASH_ENV
sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2
sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2 rename
cd ..

- save_cache:
Expand Down Expand Up @@ -471,6 +471,7 @@ jobs:
git config user.name plotlydocbot
git config user.email [email protected]
git add *
git add *
Copy link
Contributor

@nicolaskruchten nicolaskruchten Mar 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redundant?

Copy link
Contributor Author

@emmanuelle emmanuelle Mar 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hum let me fix this

git add .nojekyll
git commit -m "build of https://github.com/plotly/plotly.py/commit/${CIRCLE_SHA1}"
git push --force [email protected]:plotly/plotly.py-docs.git master:gh-pages
Expand Down
5 changes: 5 additions & 0 deletions doc/apidoc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,10 @@ help:

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
# For sphinx-apidoc the first positional path is the module to document
# then all the other ones are paths to exclude for the doc generation
%: Makefile
sphinx-apidoc -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
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html
sed -i 's/graph_objs/graph_objects/g' _build/html/*.html _build/html/generated/*.html
15 changes: 0 additions & 15 deletions doc/apidoc/_templates/class.rst
View file
Open in desktop

This file was deleted.

31 changes: 0 additions & 31 deletions doc/apidoc/_templates/class_figure.rst
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions doc/apidoc/_templates/trace.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

.. automodule:: plotly.graph_objects.{{ objname.lower() }}
:members:
:undoc-members:


.. raw:: html
Expand Down
3 changes: 1 addition & 2 deletions doc/apidoc/plotly.graph_objects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
`plotly.graph_objects`: low-level interface to figures, traces and layout
=========================================

.. currentmodule:: plotly.graph_objects
.. currentmodule:: plotly.graph_objs

:mod:`plotly.graph_objects` contains the building blocks of plotly :class:`Figure`: traces
(:class:`Scatter`, :class:`Bar`, ...) and :class:`Layout`
Expand All @@ -16,7 +16,6 @@ Figure

.. autosummary::
:toctree: generated/
:template: class_figure.rst

Figure

Expand Down
Loading