Merge pull request #946 from ZoomerAnalytics/server

xlwings REST API server
xlwings · Oct 21, 2018 · 382530e · 382530e
2 parents c319959 + 88f49dc
commit 382530e
Show file tree

Hide file tree

Showing 18 changed files with 2,496 additions and 25 deletions.
diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
@@ -1,13 +1,14 @@
 # Release process
 
+1. If the REST API docs changed: Run `/scripts/build_rest_api_docs.py` and commit the result.
 1. Add release notes to `docs/whatsnew.rst`
 2. [Create a new release](https://github.com/ZoomerAnalytics/xlwings/releases/new) with tag and name (no leading `v`): `x.x.x`
 
    This kicks off the appveyor pipeline that will:
 
-   * Build the dlls, the `xlwings.xlam` and `xlwings.bas` (they depend on the version number) and the Python package
+   * Build the dlls, the `xlwings.xlam`, the standalone files and `xlwings.bas` (they depend on the version number) and the Python package
    * Upload the Python package to pypi and `xlwings.xlam` to the GitHub release page
-   * Trigger a rebuild of xlwings.org so it is updated with latest version/date
+   * Trigger a rebuild of https://www.xlwings.org so it is updated with latest version/date
 
 3. readthedocs.org is triggering a rebuild of the `latest` (i.e. `master`) docs with every commit, but sadly it seems to fail to do so
    for the `stable` version i.e. tagged/released version, so for now login to readthedocs (using GH account) and build

diff --git a/docs/api.rst b/docs/api.rst
@@ -1,5 +1,7 @@
-API Documentation
-=================
+.. _api:
+
+Python API
+==========
 
 Top-level functions
 -------------------
@@ -10,6 +12,8 @@ Top-level functions
 Object model
 ------------
 
+.. _python_apps:
+
 Apps
 ****
 
@@ -22,12 +26,16 @@ App
 .. autoclass:: App
     :members:
 
+.. _python_books:
+
 Books
 *****
 
 .. autoclass:: xlwings.main.Books
     :members:
 
+.. _python_book:
+
 Book
 ****
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -74,7 +74,9 @@ def __getitem__(cls, key):
 extensions = ['sphinx.ext.autodoc',
               'sphinxcontrib.napoleon',
               'sphinx.ext.mathjax',
-              'sphinx.ext.extlinks']
+              'sphinx.ext.extlinks',
+              'sphinxcontrib.httpdomain',
+              ]
 
 # autodoc_member_order = 'bysource'
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -38,6 +38,7 @@ on **Windows** and **Mac**.
     r_and_julia
     extensions
     troubleshooting
+    rest_api
     api
     license
 

diff --git a/docs/index_latex.rst b/docs/index_latex.rst
@@ -23,6 +23,7 @@
     r_and_julia
     extensions
     troubleshooting
+    rest_api
     api
     license
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
-sphinxcontrib-napoleon
+sphinxcontrib-napoleon
+sphinxcontrib-httpdomain