Skip to content

Commit f12f276

Browse files
committed
Added README section on updating API specs.
1 parent 2b16a96 commit f12f276

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,31 @@ folder. After compilation, open ``docs/_build/html/index.html``. Alternatively,
5959
you can read a hosted version from `Read the Docs
6060
<http://dropbox-sdk-python.readthedocs.org/>`_.
6161

62+
Updating API specification
63+
--------------------------
64+
65+
A good amount of this SDK is generated using `Stone
66+
<https://www.github.com/dropbox/stone>`_. We use git submodules to pin to a
67+
specific version of `Stone` since it's under active development, and we also
68+
pin to a version of our `API spec
69+
<https://www.github.com/dropbox/dropbox-api-spec>`_.
70+
71+
To prepare the repo for generation, run these commands after cloning:
72+
73+
.. code-block:: bash
74+
75+
$ git submodule init
76+
$ git submodule update
77+
78+
You can run ``git pull`` within these sub repositories to update the pinned
79+
version.
80+
81+
Now, run the included script:
82+
83+
.. code-block:: bash
84+
85+
$ ./generate_base_client.py
86+
6287
Upgrading from v1
6388
-----------------
6489

0 commit comments

Comments
 (0)