Initial docs structure (#117)

DEVELOPER_GUIDE.md

@@ -34,3 +34,13 @@ globalThis.socket = io("https://127.0.0.1:8001", {
 - xlwings-server: `pip uninstall xlwings`
 - xlwings-server: `cd ~/dev/xlwings && python setup.py develop`
 - xlwings: undo deletion of `project.toml`
+
+# Build docs
+
+From the root dir, run:
+
+```
+sphinx-autobuild docs docs/_build/html  --port 9000
+```
+
+The requirements are currently under `docs/requirements.txt` and have not been included in `requirements-dev.txt` as there's an incompatibility with Python 3.9.

docs/api_coverage.md

@@ -0,0 +1,142 @@
+# API coverage
+
+
+At the moment, xlwings Server doesn't cover yet 100% of the xlwings API. The following attributes are missing at the moment. If you need them, please reach out so we can prioritize their implementation:
+
+```text
+xlwings.App
+
+    - cut_copy_mode
+    - quit()
+    - display_alerts
+    - startup_path
+    - calculate()
+    - status_bar
+    - path
+    - version
+    - screen_updating
+    - interactive
+    - enable_events
+    - calculation
+
+xlwings.Book
+
+    - to_pdf()
+    - save()
+
+xlwings.Characters
+
+    - font
+    - text
+
+xlwings.Chart
+
+    - set_source_data()
+    - to_pdf()
+    - parent
+    - delete()
+    - top
+    - width
+    - height
+    - name
+    - to_png()
+    - left
+    - chart_type
+
+xlwings.Charts
+
+    - add()
+
+xlwings.Font
+
+    - size
+    - italic
+    - color
+    - name
+    - bold
+
+xlwings.Note
+
+    - delete()
+    - text
+
+xlwings.PageSetup
+
+    - print_area
+
+xlwings.Picture
+
+    - top
+    - left
+    - lock_aspect_ratio
+
+xlwings.Range
+
+    - hyperlink
+    - formula
+    - font
+    - width
+    - formula2
+    - characters
+    - to_png()
+    - columns
+    - height
+    - formula_array
+    - paste()
+    - rows
+    - note
+    - merge_cells
+    - row_height
+    - get_address()
+    - merge()
+    - to_pdf()
+    - autofill()
+    - top
+    - wrap_text
+    - merge_area
+    - column_width
+    - copy_picture()
+    - table
+    - unmerge()
+    - current_region
+    - left
+
+xlwings.Shape
+
+    - parent
+    - delete()
+    - font
+    - top
+    - scale_height()
+    - activate()
+    - width
+    - index
+    - text
+    - height
+    - characters
+    - name
+    - type
+    - scale_width()
+    - left
+
+xlwings.Sheet
+
+    - page_setup
+    - used_range
+    - shapes
+    - charts
+    - autofit()
+    - copy()
+    - to_html()
+    - select()
+    - visible
+
+xlwings.Table
+
+    - display_name
+    - show_table_style_last_column
+    - show_table_style_column_stripes
+    - insert_row_range
+    - show_table_style_first_column
+    - show_table_style_row_stripes
+```

docs/authentication.md

@@ -0,0 +1 @@
+# Authentication

docs/aws_app_runner.md

@@ -0,0 +1 @@
+# AWS App Runner

docs/azure_functions.md

@@ -0,0 +1 @@
+# Azure Functions

docs/changelog.md

@@ -0,0 +1,78 @@
+# Changelog
+
+## 0.5.3 (Aug 24, 2024)
+
+- Avoid merge conflicts in `requirements` files when merging in upstream.
+
+## 0.5.2 (Aug 24, 2024)
+
+- Upstream GitHub Actions pipelines have been disabled on forks.
+- Simplified dependency management by getting rid of separate Windows `requirements` files.
+
+## 0.5.1 (Aug 20, 2024)
+
+- Custom functions and custom scripts can now access the current user object by using a function parameter with the `CurrentUser` as type hint, see examples.
+- Custom functions now work with thousands of concurrent requests.
+- Upgraded dependencies incl. xlwings to 0.32.1.
+
+## 0.5.0 (Aug 15, 2024)
+
+- Added support for object handles: https://docs.xlwings.org/en/latest/pro/server/officejs_custom_functions.html#object-handles
+- Added `staging` as additional environment name.
+- Dependencies are now split up into `requirements-core.in`, `requirements-dev.in`, and `requirements.in` and managed via `python run.py deps`, see README.
+- Added docker-compose production configuration under `docker` directory including Socket.IO and Redis services.
+- More custom function examples.
+- Bug fix: socket.io service now respects the `XLWINGS_APP_PATH`.
+- Added `XLWINGS_SECRET_KEY` setting.
+- Upgraded dependencies incl. xlwings to 0.32.0.
+
+## 0.4.4 (Jul 11, 2024)
+
+- Fixed an issue with custom functions when using the setting `XLWINGS_ENABLE_SOCKETIO=false`.
+- Upgraded xlwings to 0.31.10.
+
+## 0.4.3 (Jul 9, 2024)
+
+- Fixed `utils.trigger_script()` to only trigger the script 1x no matter how many times the file is open.
+- There is now an official Docker image available: https://hub.docker.com/repository/docker/xlwings/xlwings-server
+- Open Office.js alerts are now closed before showing a new alert, which would otherwise cause an error.
+- Custom functions now show errors that happen outside the app, such as timeouts.
+- Upgraded dependencies incl. xlwings to 0.31.9.
+
+## 0.4.2 (Jul 3, 2024)
+
+- If you set a valid license key as `XLWINGS_DEVELOPER_KEY` env var in your build env, building the docker container via `docker compose build` will automatically install a deploy key inside the container.
+- Fixed an issue when running the app with `XLWINGS_ENABLE_EXAMPLES=false`.
+- Upgraded dependencies incl. xlwings to 0.31.8.
+
+## 0.4.1 (Jun 26, 2024)
+
+- Upgraded xlwings-bootstrap to 5.3.3-1 and xlwings to 0.31.7
+
+## 0.4.0 (Jun 25, 2024)
+
+- Breaking change: replaced `XLWINGS_ENTRAID_VALIDATE_ISSUER` with `XLWINGS_AUTH_ENTRAID_MULTITENANT`
+- Breaking change: renamed `XLWINGS_ENTRAID_CLIENT_ID` with `XLWINGS_AUTH_ENTRAID_CLIENT_ID` and `XLWINGS_ENTRAID_TENANT_ID` with `XLWINGS_AUTH_ENTRAID_TENANT_ID`
+- Changed dependencies for validating the Entra ID JWT fro `PyJWT` to `joserfc`
+- Allows to provide an own function for retrieving the Entra ID JWKS (JSON Web Key Set), allowing to enable the Entra ID auth functionality on airgapped servers
+- Allow to use multiple auth providers on the backend. This is helpful if you want to use the same backend from Office.js via Entra ID and from Google Sheets via Google OAuth, for example.
+- Enabling auth now requires to set `XLWINGS_AUTH_PROVIDERS`, e.g., `XLWINGS_AUTH_PROVIDERS=["entraid"]`
+- Upgraded dependencies incl. xlwings to 0.31.6.
+
+## 0.3.0 (Jun 18, 2024)
+
+- Introduced `@script` decorator and `xw-click` HTML tag, see `app/custom_scripts/examples.py`.
+- Introduced `app.utils.trigger_script()` to trigger a custom script from within a custom function, see `app/custom_functions/examples.py`.
+- Bootstrap can now be disabled via `XLWINGS_ENABLE_BOOTSTRAP=false`.
+- `python run.py` now runs locally without `certs`, which allows it to be used with VBA or Office Scripts (Office.js always require certs).
+- Upgraded dependencies incl. xlwings to 0.31.5.
+
+## 0.2.0 (Jun 4, 2024)
+
+- New settings `XLWINGS_APP_PATH` and `XLWINGS_STATIC_URL_PATH` that allow to mount the app on a non root-path such as https://my.domain.com/app.
+- New setting `XLWINGS_DATE_FORMAT` to override/fix the date format in custom functions.
+- Upgraded xlwings to 0.31.4.
+
+## 0.1.0 (May 27, 2024)
+
+- First release.

docs/client_configuration.md

@@ -0,0 +1 @@
+# Client Configuration