Permalink
Browse files

Misc docs and tests for 0.12.4 release (#5654)

* update some quad/rect examples to vbar/hbar

* fixes #4877 add ImageSource

* Simplify maintenacnce of Bokeh release notes docs

This commit adds a :bokeh-index-toctree: that will properly sort release
docs that are included in the tocree by means of a glob. Accordingly,
the complicated logic in the deploy.py script that updated the toctree
manually has been removed.

The :bokeh-issues: directive had the format of its output upadated.

This commit also adds preliminary release notes for 0.12.4 and fixes
typos in previous release notes.

* Split glyphs and markers ref docs to one page each

To accomplish this a few tangential tasks were necessary:

* Cruft HasProps.set removed to prevent docs warning
* ReST replace directives moved to rst_prolog in conf.py to prevent dupes

* show properties before methods in model docs

* Added additional details section to server developer docs

* update message for missing models

* Expand docs for embedding Bokeh server

* Add examples under howto/server_embed
* Create SVG notional diagrams for Bokeh server operation
* Update user guide server section

* improve docs for Document

* Fixes #5408 devguide links
  • Loading branch information...
1 parent ebe8908 commit 1c0433bcd6928e55ee70e582fd538c3bc854d04e @bryevdv bryevdv committed on GitHub Jan 9, 2017
Showing with 1,654 additions and 515 deletions.
  1. +0 −37 bokeh/core/has_props.py
  2. +0 −7 bokeh/core/properties.py
  3. +0 −7 bokeh/core/property/descriptors.py
  4. +1 −1 bokeh/core/tests/test_has_props.py
  5. +2 −2 bokeh/core/tests/test_properties.py
  6. +282 −51 bokeh/document.py
  7. +35 −4 bokeh/models/glyphs.py
  8. +30 −4 bokeh/models/markers.py
  9. +1 −0 bokeh/sphinxext/bokeh_autodoc.py
  10. +1 −1 bokeh/sphinxext/bokeh_gallery.py
  11. +4 −4 bokeh/sphinxext/bokeh_github.py
  12. +57 −0 bokeh/sphinxext/bokeh_index_toctree.py
  13. +2 −0 bokeh/sphinxext/bokeh_plot.py
  14. +2 −4 bokehjs/src/coffee/base.coffee
  15. +2 −0 conda.recipe/meta.yaml
  16. +33 −42 examples/embed/widget.py
  17. +58 −0 examples/howto/server_embed/flask_embed.py
  18. +180 −0 examples/howto/server_embed/notebook_embed.ipynb
  19. +40 −0 examples/howto/server_embed/standalone_embed.py
  20. +54 −0 examples/howto/server_embed/tornado_embed.py
  21. +31 −49 examples/models/population_server.py
  22. +4 −6 examples/plotting/file/boxplot.py
  23. +2 −5 examples/plotting/file/candlestick.py
  24. +3 −6 examples/plotting/file/custom_datetime_axis.py
  25. +0 −30 scripts/deploy.py
  26. +3 −0 sphinx/draw.io/README.md
  27. +1 −0 sphinx/draw.io/bokeh_serve.xml
  28. +1 −0 sphinx/draw.io/bokeh_serve_client.xml
  29. +1 −0 sphinx/draw.io/bokeh_serve_scale.xml
  30. +1 −0 sphinx/draw.io/document.xml
  31. +2 −0 sphinx/source/_images/bokeh_serve.svg
  32. +2 −0 sphinx/source/_images/bokeh_serve_client.svg
  33. +2 −0 sphinx/source/_images/bokeh_serve_scale.svg
  34. +2 −0 sphinx/source/_images/document.svg
  35. +16 −0 sphinx/source/conf.py
  36. +175 −183 sphinx/source/docs/dev_guide/server.rst
  37. +1 −1 sphinx/source/docs/reference/models.rst
  38. +6 −2 sphinx/source/docs/reference/models/glyphs.rst
  39. +8 −0 sphinx/source/docs/reference/models/glyphs/annular_wedge.rst
  40. +8 −0 sphinx/source/docs/reference/models/glyphs/annulus.rst
  41. +8 −0 sphinx/source/docs/reference/models/glyphs/arc.rst
  42. +8 −0 sphinx/source/docs/reference/models/glyphs/bezier.rst
  43. +8 −0 sphinx/source/docs/reference/models/glyphs/ellipse.rst
  44. +8 −0 sphinx/source/docs/reference/models/glyphs/hbar.rst
  45. +8 −0 sphinx/source/docs/reference/models/glyphs/image.rst
  46. +8 −0 sphinx/source/docs/reference/models/glyphs/image_rgba.rst
  47. +8 −0 sphinx/source/docs/reference/models/glyphs/image_url.rst
  48. +8 −0 sphinx/source/docs/reference/models/glyphs/line.rst
  49. +8 −0 sphinx/source/docs/reference/models/glyphs/multi_line.rst
  50. +8 −0 sphinx/source/docs/reference/models/glyphs/oval.rst
  51. +8 −0 sphinx/source/docs/reference/models/glyphs/patch.rst
  52. +8 −0 sphinx/source/docs/reference/models/glyphs/patches.rst
  53. +8 −0 sphinx/source/docs/reference/models/glyphs/quad.rst
  54. +8 −0 sphinx/source/docs/reference/models/glyphs/quadratic.rst
  55. +8 −0 sphinx/source/docs/reference/models/glyphs/ray.rst
  56. +8 −0 sphinx/source/docs/reference/models/glyphs/rect.rst
  57. +8 −0 sphinx/source/docs/reference/models/glyphs/segment.rst
  58. +8 −0 sphinx/source/docs/reference/models/glyphs/text.rst
  59. +8 −0 sphinx/source/docs/reference/models/glyphs/vbar.rst
  60. +8 −0 sphinx/source/docs/reference/models/glyphs/wedge.rst
  61. +8 −0 sphinx/source/docs/reference/models/images.rst
  62. +6 −2 sphinx/source/docs/reference/models/markers.rst
  63. +8 −0 sphinx/source/docs/reference/models/markers/asterisk.rst
  64. +8 −0 sphinx/source/docs/reference/models/markers/circle.rst
  65. +8 −0 sphinx/source/docs/reference/models/markers/circle_cross.rst
  66. +8 −0 sphinx/source/docs/reference/models/markers/circle_x.rst
  67. +8 −0 sphinx/source/docs/reference/models/markers/cross.rst
  68. +8 −0 sphinx/source/docs/reference/models/markers/diamond.rst
  69. +8 −0 sphinx/source/docs/reference/models/markers/diamond_cross.rst
  70. +8 −0 sphinx/source/docs/reference/models/markers/inverted_triangle.rst
  71. +8 −0 sphinx/source/docs/reference/models/markers/square.rst
  72. +8 −0 sphinx/source/docs/reference/models/markers/square_cross.rst
  73. +8 −0 sphinx/source/docs/reference/models/markers/square_x.rst
  74. +8 −0 sphinx/source/docs/reference/models/markers/triangle.rst
  75. +8 −0 sphinx/source/docs/reference/models/markers/x.rst
  76. +7 −0 sphinx/source/docs/reference/sphinxext.rst
  77. +2 −2 sphinx/source/docs/releases/0.12.3.rst
  78. +182 −0 sphinx/source/docs/releases/0.12.4.rst
  79. +130 −36 sphinx/source/docs/user_guide/server.rst
  80. +2 −29 sphinx/source/index.rst
@@ -6,10 +6,6 @@
classes or their methods will be applicable to any standard usage or to
anyone who is not directly developing on Bokeh's own infrastructure.
-.. |HasProps| replace:: :class:`~bokeh.core.has_props.HasProps`
-.. |Property| replace:: :class:`~bokeh.core.property.bases.Property`
-.. |PropertyDescriptor| replace:: :class:`~bokeh.core.property.descriptors.PropertyDescriptor`
-
'''
from __future__ import absolute_import
@@ -536,39 +532,6 @@ def query_properties_with_values(self, query, include_defaults=True):
return result
- def set(self, **kwargs):
- ''' Updates the object's properties from the given keyword arguments.
-
- THIS FUNCTION IS DEPRECATED. Use the .update method instead.
-
- Returns:
- None
-
- Examples:
-
- The following are equivalent:
-
- .. code-block:: python
-
- from bokeh.models import Range1d
-
- r = Range1d
-
- # set properties individually:
- r.start = 10
- r.end = 20
-
- # update properties together:
- r.update(start=10, end=20)
-
- '''
-
- from bokeh.util.deprecation import deprecated
- deprecated((0, 12, 4), 'set method', 'update method')
-
- for kw in kwargs:
- setattr(self, kw, kwargs[kw])
-
# TODO (bev) could this return an empty dict instead of None?
def themed_values(self):
''' Get any theme-provided overrides.
@@ -88,13 +88,6 @@ class SomeModel(Model):
.. autoclass:: Include
.. autoclass:: Override
-.. |Color| replace:: :func:`~bokeh.core.properties.Color`
-.. |DataSpec| replace:: :func:`~bokeh.core.properties.DataSpec`
-.. |field| replace:: :func:`~bokeh.core.properties.field`
-.. |HasProps| replace:: :func:`~bokeh.core.has_props.HasProps`
-.. |value| replace:: :func:`~bokeh.core.properties.value`
-
-
'''
from __future__ import absolute_import, print_function
@@ -68,13 +68,6 @@ class Range(Model):
.. _descriptor protocol: https://docs.python.org/3/howto/descriptor.html
-.. |DataSpec| replace:: :class:`~bokeh.core.properties.DataSpec`
-.. |HasProps| replace:: :class:`~bokeh.core.has_props.HasProps`
-.. |Property| replace:: :class:`~bokeh.core.properties.Property`
-.. |PropertyContainer| replace:: :class:`~bokeh.core.property.containers.PropertyContainer`
-.. |PropertyDescriptor| replace:: :class:`~bokeh.core.property.descriptor.PropertyDescriptor`
-.. |UnitsSpec| replace:: :class:`~bokeh.core.properties.UnitsSpec`
-
'''
from __future__ import absolute_import
@@ -127,7 +127,7 @@ def test_HasProps_update_from_json_passes_models_and_setter(mock_set):
def test_HasProps_set():
c = Child()
- c.set(**dict(lst2=[1,2], str2="baz", int1=25, ds1=dict(field="foo")))
+ c.update(**dict(lst2=[1,2], str2="baz", int1=25, ds1=dict(field="foo")))
assert c.int1 == 25
assert c.ds1 == dict(field="foo")
assert c.lst1 == []
@@ -96,12 +96,12 @@ class Foo(HasProps):
self.assertEqual(f.x, 12)
self.assertEqual(f.y, "red")
self.assertEqual(f.z, "blah")
- f.set(**dict(x=20, y="green", z="hello"))
+ f.update(**dict(x=20, y="green", z="hello"))
self.assertEqual(f.x, 20)
self.assertEqual(f.y, "green")
self.assertEqual(f.z, "hello")
with self.assertRaises(ValueError):
- f.set(y="orange")
+ f.update(y="orange")
def test_no_parens(self):
class Foo(HasProps):
Oops, something went wrong.

0 comments on commit 1c0433b

Please sign in to comment.