kundali-chart-mcp 0.2.3 → 0.2.5

package/README.md

@@ -1,6 +1,6 @@
 # 🪔 Kundali Chart MCP
 
-**The most comprehensive Vedic Astrology MCP server — 48 tools, zero dependencies.**
+**The most comprehensive Vedic Astrology MCP server — 48 tools, zero setup.**
 
 [![npm version](https://img.shields.io/npm/v/kundali-chart-mcp?color=orange)](https://www.npmjs.com/package/kundali-chart-mcp)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
@@ -12,36 +12,53 @@
 ## 🚀 Quick Start
 
 ```bash
-npm install -g kundali-chart-mcp
-kundali-chart-mcp-setup
+npx kundali-chart-mcp
 ```
 
-Then restart your IDE. That's it.
+That's it. The server connects to a hosted backend — no Python, no dependencies, no configuration.
+
+### Auto-setup (recommended)
+
+```bash
+npx kundali-chart-mcp-setup
+```
+
+This automatically configures Kundali Chart MCP for Claude Desktop, Cursor, VS Code, Windsurf, and Zed. Restart your IDE after running.
+
+---
 
 ## 💬 Try This
 
 > *"Generate a kundali chart for someone born on 15 August 1990 at 6:30 AM in Mumbai, India"*
 
+> *"What doshas are present in my chart? Born 6 Nov 2002, 12:05 PM, Bareilly"*
+
+> *"Show me my Vimshottari Dasha periods"*
+
+> *"Check compatibility between these two charts..."*
+
 ---
 
 ## ✨ Features
 
-- **48 astrology tools** — Charts, doshas, yogas, dasha, transits, compatibility, muhurta
-- **Zero local dependencies** — No Python, no ephemeris files
+- **48 astrology tools** — Charts, doshas, yogas, dasha, transits, compatibility, muhurta, and more
+- **Zero setup** — No Python, no files, no configuration needed
 - **AI-ready** — Works with Claude, Cursor, ChatGPT, Gemini, Copilot, any MCP client
-- **Free backend** — Hosted on Azure Functions
-- **Self-hostable** — Deploy your own in 5 minutes
-- **BPHS-grade** — Uses Swiss Ephemeris + vedicastro
+- **Professional grade** — Swiss Ephemeris engine, BPHS-standard calculations
+- **Always up-to-date** — Hosted backend means you always get the latest calculations
 
 ---
 
 ## 🔧 Manual Config
 
+If auto-setup doesn't work for your IDE, add this to your MCP configuration:
+
 ```json
 {
   "mcpServers": {
     "kundali-chart": {
-      "command": "kundali-chart-mcp"
+      "command": "npx",
+      "args": ["kundali-chart-mcp"]
     }
   }
 }
@@ -52,160 +69,63 @@ Then restart your IDE. That's it.
 ## 🪔 All 48 Tools
 
 ### Core Chart
-- `generate_kundali` — Full Vedic birth chart with all 9 planets, 12 houses, nakshatras
+- `generate_kundali` — Full Vedic birth chart (9 planets, 12 houses, nakshatras)
 - `list_available_chart_types` — D1–D60 vargas
 - `list_ayanamsa_modes` — 30+ sidereal modes
 - `list_house_systems` — Placidus, Koch, Equal, Whole Sign, etc.
-- `get_transit_positions` — Planetary transits
+- `get_transit_positions` — Current planetary transits
 - `search_birth_places` — City geocoding
 - `get_timezone_for_coordinates` — Timezone from lat/lon
 
 ### Extended Analysis
 - `get_extended_chart` — KP SubLord data
-- `get_vimshottari_dasha` — Vimshottari Dasha
-- `get_pratyantar_dasha` — 3-level dasha
-- `get_sookshma_dasha` — 4th level
-- `get_prana_dasha` — 5th level
-- `get_yogini_dasha` — 8-yogini cycle
-- `get_kalachakra_dasha` — 112-year cycle
+- `get_vimshottari_dasha` — Vimshottari Dasha (mahadasha + antardasha)
+- `get_pratyantar_dasha` — 3-level dasha (MD → AD → PD)
+- `get_sookshma_dasha` — 4th level dasha
+- `get_prana_dasha` — 5th level dasha
+- `get_yogini_dasha` — 8-yogini, 36-year cycle
+- `get_kalachakra_dasha` — 112-year sign-based dasha
 - `get_char_dasha` — Jaimini Chara Dasha
 - `get_narayana_dasha` — Jaimini Narayana Dasha
-- `get_ashtottari_dasha` — 108-year cycle
-- `get_planetary_aspects` — All aspects
-- `get_significators` — KP significators
+- `get_ashtottari_dasha` — 108-year, 8-planet cycle
+- `get_planetary_aspects` — All planetary aspects
+- `get_significators` — KP planet-wise and house-wise significators
 
 ### Yogas & Doshas
-- `get_yogas` — Raj Yoga, Gaja Kesari, Dhana, etc.
-- `get_doshas` — Mangal, Kaal Sarp, Sade Sati
-- `get_special_conditions` — Vargottama, Dig Bala
-- `get_nabhasha_yogas` — Ashrayas, Dala, Akriti
-- `get_arishta` — Longevity assessment
-- `get_kartari` — Kartari Yoga
-- `get_gandanta` — Gandanta zones
+- `get_yogas` — Raj Yoga, Gaja Kesari, Dhana Yoga, and 50+ more
+- `get_doshas` — Mangal Dosha, Kaal Sarp Dosha, Sade Sati, Graha Yuddha, Combustion
+- `get_special_conditions` — Vargottama, Pushkara Navamsha, Dig Bala, Jaimini Karakas
+- `get_nabhasha_yogas` — Ashrayas, Dala, Akriti yogas
+- `get_arishta` — Longevity assessment yogas
+- `get_kartari` — Kartari Yoga (hemmed between benefics/malefics)
+- `get_gandanta` — Gandanta zone analysis
 
 ### Panchanga & Muhurta
 - `get_panchanga` — Tithi, Vara, Nakshatra, Yoga, Karana
-- `get_muhurta` — Auspicious timing score
-- `get_best_muhurta` — Top 5 windows
+- `get_muhurta` — Auspicious timing score for any datetime
+- `get_best_muhurta` — Top 5 auspicious windows in a date range
 - `get_hora` — Planetary Hour
 
 ### Transits & Returns
-- `get_gochara` — Transit analysis
-- `get_varshaphal` — Solar Return
-- `get_tajaka` — Tajaka analysis
-- `get_lunar_return` — Chandraphal
-- `get_bhava_chalit` — House positions
+- `get_gochara` — Vedic transit analysis
+- `get_varshaphal` — Solar Return chart
+- `get_tajaka` — Tajaka annual analysis
+- `get_lunar_return` — Chandraphal (Lunar Return)
+- `get_bhava_chalit` — Actual house positions
 
 ### Compatibility & Special
-- `get_compatibility` — Ashtakoot Milan (36-point)
-- `get_jaimini` — Full Jaimini analysis
-- `get_shadbala` — Six-fold strength
-- `get_ashtakavarga` — Benefic points
-- `get_avasthas` — 9 planetary states
-- `get_upagrahas` — Shadow sub-planets
-- `get_nakshatra_analysis` — Deep nakshatra info
-- `get_sudarshana_chakra` — Triple-layer chart
-- `get_prasna` — Horary chart
+- `get_compatibility` — Ashtakoot Milan (36-point marriage compatibility)
+- `get_jaimini` — Full Jaimini analysis: Chara Karakas, aspects, Karakamsha
+- `get_shadbala` — Six-fold planetary strength
+- `get_ashtakavarga` — Benefic point scores
+- `get_avasthas` — 9 planetary states + Baladi Avasthas
+- `get_upagrahas` — Shadow sub-planets: Gulika, Mandi, Dhuma
+- `get_nakshatra_analysis` — Deep nakshatra information per planet
+- `get_sudarshana_chakra` — Triple-layer chart analysis
+- `get_prasna` — Horary/Question chart
 - `get_kurmachakra` — Directional analysis
-- `get_travel_direction_score` — Direction score (0-100)
-- `get_full_kurmachakra_chart` — All 9 directions
-
----
-
-## 🏗 Self-Host Your Own
-
-Don't want to use the shared backend? Deploy in 5 minutes.
-
-### Prerequisites
-
-- [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli) installed
-- An Azure account ([free trial](https://azure.microsoft.com/free) works)
-
-### Deploy
-
-```bash
-# Login to Azure
-az login
-
-# Create resource group
-az group create --name kundali-rg --location eastus
-
-# Create storage account (needs globally unique name)
-az storage account create --name kundalistorage$RANDOM \
-  --resource-group kundali-rg --location eastus --sku Standard_LRS
-
-# Create function app
-az functionapp create --name kundali-mcp-func \
-  --resource-group kundali-rg \
-  --storage-account kundalistorage \
-  --consumption-plan-location eastus \
-  --runtime python --runtime-version 3.11 \
-  --os-type Linux --functions-version 4
-
-# Deploy the code
-./deploy.sh
-```
-
-### Use your own URL
-
-```bash
-kundali-chart-mcp https://kundali-mcp-func.azurewebsites.net
-kundali-chart-mcp-setup
-```
-
----
-
-## 📡 Direct API (without MCP)
-
-You can also call the backend directly — no MCP client needed.
-
-### Base URL
-```
-https://kundali-mcp-func.azurewebsites.net/api/kundali/{toolName}
-```
-
-### Health check
-```bash
-curl -X POST https://kundali-mcp-func.azurewebsites.net/api/kundali/health \
-  -H "Content-Type: application/json" -d '{}'
-```
-
-### Generate kundali
-```bash
-curl -X POST https://kundali-mcp-func.azurewebsites.net/api/kundali/generate_kundali \
-  -H "Content-Type: application/json" -d '{
-    "name": "Rahul",
-    "city": "Mumbai, India",
-    "date_of_birth": "1990-08-15",
-    "time_of_birth": "06:30",
-    "latitude": 19.076,
-    "longitude": 72.8777,
-    "timezone": "Asia/Kolkata"
-  }'
-```
-
-### List available tools
-```bash
-curl -X POST https://kundali-mcp-func.azurewebsites.net/api/kundali/list_available_chart_types \
-  -H "Content-Type: application/json" -d '{}'
-```
-
-### Response format
-
-All endpoints return JSON:
-```json
-{
-  "name": "Rahul",
-  "birth_details": {
-    "datetime": "1990-08-15T06:30:00",
-    "latitude": 19.076,
-    "longitude": 72.8777,
-    "timezone": "Asia/Kolkata"
-  },
-  "planetary_positions": [...],
-  "houses": [...]
-}
-```
+- `get_travel_direction_score` — Direction auspiciousness score (0-100)
+- `get_full_kurmachakra_chart` — All 9 directions reference
 
 ---
 

package/azure-function/flatlib/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 FlatAngle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/azure-function/flatlib/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+include README.rst

package/azure-function/flatlib/README.md

@@ -0,0 +1,31 @@
+# flatlib
+
+Flatlib is a python library for Traditional Astrology.
+
+```python
+
+>>> date = Datetime('2015/03/13', '17:00', '+00:00')
+>>> pos = GeoPos('38n32', '8w54')
+>>> chart = Chart(date, pos)
+
+>>> sun = chart.get(const.SUN)
+>>> print(sun)
+<Sun Pisces +22:47:25 +00:59:51>
+
+```
+
+## Documentation
+
+Flatlib's documentation is available at [http://flatlib.readthedocs.org/](http://flatlib.readthedocs.org/).
+
+
+## Installation
+
+Flatlib is a Python 3 package, make sure you have Python 3 installed on your system. 
+
+You can install flatlib with `pip3 install flatlib` or download the latest stable version from [https://pypi.python.org/pypi/flatlib](https://pypi.python.org/pypi/flatlib) and install it with `python3 setup.py install`. 
+
+
+## Development
+
+You can clone this repository or download a zip file using the right side buttons. 

package/azure-function/flatlib/README.rst

@@ -0,0 +1,47 @@
+flatlib
+=======
+
+A Python 3 library for Traditional Astrology.
+
+
+Example
+-------
+
+::
+
+    >>> date = Datetime('2015/03/10', '14:00', '+00:00')
+    >>> pos = GeoPos('38n32', '8w54')
+    >>> chart = Chart(date, pos)
+
+    >>> sun = chart.get(const.SUN)    
+    >>> print(sun)
+    <Sun Pisces +19:40:13 +00:59:57>
+
+
+Changelog
+---------
+
+* 0.2.1 (released 06-05-2016)
+    - Added Pars Horsemanship
+    - Return accidental dignities that score more than zero
+    - Added chartdynamics.disposits to return dignities where planet A disposes a planet B
+    - Includes new Triplicity Faces
+
+* 0.2.0 (released 08-04-2015)
+    - Many new features:
+        - Planetary time
+        - Arabic Parts
+        - Chart Dynamics
+        - Accidental dignities
+        - Predictives (Profections, Solar Returns and Primary Directions)
+        - Protocols (Almutem, Temperament and Behavior calculations)
+    - Bug fixes
+    
+* 0.1.1 (released 18-03-2015)
+    - Changed threshold for stationary (1 arc-second)
+    - Implementation of essential dignities
+    - Added essential dignities recipe
+
+* 0.1.0 (released 14-03-2015)
+    - Initial release
+    - Implementation of core modules

package/azure-function/flatlib/docs/Makefile

@@ -0,0 +1,195 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/flatlib.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/flatlib.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/flatlib"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/flatlib"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+livehtml:
+	sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

package/azure-function/flatlib/docs/README.md

@@ -0,0 +1,37 @@
+# Flatlib documentation
+
+This document explains how you can setup your environment to build and contribute to the flatlib documentation.
+
+
+## Readthedocs
+
+Flatlib's documentation is available at [http://flatlib.readthedocs.org/](http://flatlib.readthedocs.org/). Every change to this repository triggers an immediate documentation build on the readthedocs server. 
+
+
+## Installing Sphinx and Sphinx-autobuild
+
+### Sphinx
+
+The flatlib documentation is built from reStructuredText sources using [Sphinx](http://sphinx-doc.org/). 
+The preferred way of installing Sphinx is with pip:
+
+* `pip install sphinx` on Linux or Mac.
+* `py pip install sphinx` on Windows.
+
+Refer to the [Sphinx documentation](http://sphinx-doc.org/install.html) for alternative ways to install Sphinx in your environment.
+
+### Sphinx-autobuild
+
+Sphinx-autobuild is a tool to watch a Sphinx directory and rebuild the documentation when a change is detected. 
+To install sphinx-autobuild use:
+
+* `pip install sphinx-autobuild` on Linux or Mac.
+* `py pip install sphinx-autobuild` on Windows.
+
+
+## Build the documention
+
+There are two ways for building the documentation, both made possible by the available makefiles. Open a terminal or command prompt and *cd* into the *docs* directory: 
+
+* To build the HTML documentation, execute `make html`. The generated documentation will be at *docs/build/html*.
+* Execute `make livehtml` to start the autobuild server. Visit the webpage served at `localhost:8000`, and the server will autoreload the page when a change is detected. Quit the server by pressing Ctrl+C (or Command+C).