diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index d817b46f5960a81589c940ea58dd1e811b27326d..87a8d73a23223e688788fe8fe4973a82dda84158 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -58,6 +58,7 @@ check-typing: doc: script: + - make clean - make html artifacts: paths: diff --git a/doc/Deserializer.rst b/doc/Deserializer.rst index 81d2cfe3e77caefe335c884bd6cb045a48eed71e..c15f348122dfa9fdc9c00c06b06196bcd475415d 100644 --- a/doc/Deserializer.rst +++ b/doc/Deserializer.rst @@ -1,6 +1,5 @@ Overview -======================== - +======== PlotSerializer also provides the functionality of converting the JSON file back into a diagram. Only serialized attributes can influence the deserialized plot, the created graph might thus look slightly different from the original, the data however will remain unchanged. diff --git a/doc/diagrams.rst b/doc/diagrams.rst index 47f453a6448d357f3a4ee3c360e2711f0555040c..ad6f7d0adb489abc9bc2da93ce015b6f2b1d0d2c 100644 --- a/doc/diagrams.rst +++ b/doc/diagrams.rst @@ -1,5 +1,5 @@ How PloSe sees diagrams -================================ +======================= PloSe uses its own data model for representing scientific diagrams. The data model was designed as a general representation of scientific diagrams. The base class for this data model is ``plot_serializer.model.Figure``. diff --git a/doc/howitworks.rst b/doc/howitworks.rst index 619bc623b73bc8187af6c825cc68e6a2117ec4c4..4f9fbd37860a3bc6e6194f72e671fed4e1f1f32a 100644 --- a/doc/howitworks.rst +++ b/doc/howitworks.rst @@ -165,7 +165,7 @@ This information about the color relates to each trace, so to inspect it in the Using Serializer object vs. matplotlib.pyplot ------------------------------------------- +--------------------------------------------- So far the Serializer class for Matplotlib only supports the subplots and show method, meaning any other operations on the pyplot object will not get serialized and making such changes to your plot still requires calling the functions on the pyplot object. The reason for this being that the Serializer was not implemented as a fully functional proxy for the pyplot object like the AxesProxy class is for Axes of matplotlib.axes. diff --git a/doc/matplotlib_json_spec_0.2.0.rst b/doc/matplotlib_json_spec_0.2.0.rst index 24a2f787af615a25f7d7a26454ba4d247d0c05c3..4d0b01bf329a973f7b989ddcaaef01a0b3c47a66 100644 --- a/doc/matplotlib_json_spec_0.2.0.rst +++ b/doc/matplotlib_json_spec_0.2.0.rst @@ -1,6 +1,5 @@ Matplotlib PlotSerializer 0.2.0 -================ - +================================ .. code-block:: json { diff --git a/doc/user_guide.rst b/doc/user_guide.rst index e5c7b41f5813bde791a3239576f9fae1983724be..0f6bfb47dbd4f5faf15515b805405611617bb3bd 100644 --- a/doc/user_guide.rst +++ b/doc/user_guide.rst @@ -46,7 +46,7 @@ PloSe also allows for deserialization of JSON-ized plots into matplotlib. :hidden: :caption: Deserializing with PloSe - deserializer + Deserializer json_deserializer .. toctree::