docs: readthedocs documentation update and abstractapi link update

mendrugory · Oct 21, 2021 · 165de2e · 165de2e
1 parent 613bef3
commit 165de2e
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -59,5 +59,11 @@ ioloop.add_callback(function)
 ioloop.start()
 ```
 
-[ABAPI]:<https://app.abstractapi.com/api/ip-geolocation/documentation>
-[IPAPI]: <http://ip-api.com/>
+[ABAPI]:<https://www.abstractapi.com/ip-geolocation-api>
+[IPAPI]: <http://ip-api.com/>
+
+## Docs
+
+* [github](https://github.com/mendrugory/torip)
+* [pypi](https://pypi.org/project/torip/)
+* [readthedocs](https://torip.readthedocs.io)
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= ../venv/bin/sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,2 @@
+extensions = ["myst_parser"]
+source_suffix = ['.rst', '.md']
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,3 @@
+.. include:: ../README.md
+   :parser: myst_parser.docutils_
+
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,3 @@
 coverage==4.0.1
 tornado==6.1
+myst-parser==0.15.2
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		extensions = ["myst_parser"]
		source_suffix = ['.rst', '.md']
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		.. include:: ../README.md
		:parser: myst_parser.docutils_