Skip to content

Commit

Permalink
Update Thrift bindings for 5.1 (#295)
Browse files Browse the repository at this point in the history
* Update mapd.thrift bindings

* Clean up contributing page
  • Loading branch information
Randy Zwitch authored Feb 20, 2020
1 parent 215087c commit 6c23917
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 22 deletions.
22 changes: 2 additions & 20 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,28 +127,10 @@ When the upstream `mapd-core`_ project updates its Apache Thrift definition file
thrift -gen py completion_hints.thrift
thrift -gen py common.thrift
thrift -gen py serialized_result_set.thrift
thrift -gen py extension_functions.thrift
After the bindings are generated, copy them to their respective folders in the pymapd repo. Each set of Thrift files
are their own package within the overall pymapd package. Also, take note to remove unneeded imports as shown in this `commit`_, as the unneeded imports
can be problematic, especially when calling pymapd from other languages (specifically, R).

--------------------------
Updating the Documentation
--------------------------

The documentation for pymapd is generated by ReadTheDocs on each commit. Some pages (such as this one) are manually created,
others such as the API Reference is generated by the docstrings from each method.

If you are planning on making non-trival changes to the documentation and want to preview the result before making a commit,
you need to install sphinx and sphinx-rtd-theme into your development environment:

.. code-block:: shell
pip install sphinx sphinx-rtd-theme
Once you have sphinx installed, to build the documentation switch to the ``pymapd/docs`` directory and run ``make html``. This will update the documentation
in the ``pymapd/docs/build/html`` directory. From that directory, running ``python -m http.server`` will allow you to preview the site on ``localhost:8000``
in the browser. Run ``make html`` each time you save a file to see the file changes in the documentation.
are their own package within the overall pymapd package.

--------------------------
Updating the Documentation
Expand Down
28 changes: 26 additions & 2 deletions omnisci/mapd/ttypes.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6c23917

Please sign in to comment.