generate documentation with sphinx - fix #27

Author: SamR1

.gitignore

@@ -17,3 +17,6 @@ tootrss_clientcred.txt
 tootrss_usercred.txt
 *.log
 /twootfeed.egg-info/
+
+## Doc
+/docsrc/build/

Makefile

@@ -13,9 +13,16 @@ clean:
 create-mastodon-cli:
 	$(PYTHON) twootfeed/utils/create_mastodon_client.py
 
+html:
+	rm -rf docsrc/build
+	rm -rf docs/*
+	touch docs/.nojekyll
+	$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	cp -a docsrc/build/html/. docs
+
 install:
 	test -d $(VENV) || virtualenv $(VENV) -p $(PYTHON_VERSION)
-	$(PIP) install -e .[test]
+	$(PIP) install -e .[test,doc]
 	test -e twootfeed/config.yml || cp twootfeed/config.example.yml twootfeed/config.yml
 
 serve:

Makefile.config

@@ -17,3 +17,9 @@ PIP = $(VENV)/bin/pip
 FLASK = $(VENV)/bin/flask
 PYTEST = $(VENV)/bin/py.test
 GUNICORN = $(VENV)/bin/gunicorn
+
+#Sphinx Docs
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= $(VENV)/bin/sphinx-build
+SOURCEDIR     = docsrc/source
+BUILDDIR      = docsrc/build

README.md

@@ -20,87 +20,9 @@ The RSS feed displays only the original tweets (not the retweets) and toots, wit
 - source
 - location (only for Twitter)
 - numbers of retweets and likes for tweets and boosts and favourites for toots   
-(see examples below).  
 
-## Requirements
 
-- Python 3.6+
-- API keys Twitter and/or Mastodon 
-
-  
-## Installation and configuration
-
-- Install from pip
-
-```bash
-$ pip install twootfeed
-```
-
-- Initialize the configuration file
-```bash
-$ twootfeed_init
-```
-
-- Fill in fields for the client(s) you will use in **'~/.config/twootfeed/config.yml'** :
-  - for **Twitter** : see https://apps.twitter.com  
-  copy/paste the Twitter API key values in **config.yml** file ('_consumerKey_' and '_consumerSecret_')
-  - for **Mastodon** : see [Python wrapper for the Mastodon API](https://mastodonpy.readthedocs.io/)  
-  use the included script which will register your app and prompt you to log in, creating the credential files for you.
-  ```bash
-  $ twootfeed_create_mastodon_cli
-  ```
-  Update the [feed and app parameters](https://github.com/SamR1/python-twootfeed/wiki/Application-parameters).
-
-  
-- The files location can be changed with the following environment variables:
-
-| variable               | description                                   | app default value                                                                         |
-|------------------------|-----------------------------------------------| ------------------------------------------------------------------------------------------|
-| `TWOOTFEED_CONFIG_DIR` | configuration and credentials files directory | **'~/.config/twootfeed/'**                                                                |
-| `TWOOTFEED_CONFIG_FILE`| config file full path                         | config dir + **'config.yml'** => with default value: **'~/.config/twootfeed/config.yml'** |
-| `TWOOTFEED_LOG`        | application log file                          | _no default value (log printed on the console)_                                           |
-
-- Start the app
-```bash
-$ twootfeed
-```
-
-## Usage 
-
-The RSS feeds are available on these urls:  
-  - for Twitter: http://localhost:8080/<keywords> or http://localhost:8080/tweets/<keywords>
-  - for Mastodon: 
-    - search:
-        - keyword as a hashtag: http://localhost:8080/toots/<hashtag> (without the leading #)
-        - query: http://localhost:8080/toot_search/<query>
-    - connected user favourites: http://localhost:8080/toot_favorites
-
-
-## Examples 
-
-### Search on Twitter 
-
-![Twitter search](https://raw.githubusercontent.com/SamR1/python-twootfeed/master/images/twitter.png)  
-
-Results in RSS Feed:  
-![RSS Feed](https://raw.githubusercontent.com/SamR1/python-twootfeed/master/images/RSSFeed.png)  
-  
-Display on FreshRSS, a great free self-hosted aggregator (https://github.com/FreshRSS/FreshRSS):   
-![FreshRSS](https://raw.githubusercontent.com/SamR1/python-twootfeed/master/images/FreshRSS.png)  
-
-### Search on Mastodon
-
-![Mastodon search](https://raw.githubusercontent.com/SamR1/python-twootfeed/master/images/mastodon.png)
-
-Results in RSS Feed:  
-![Mastodon Feed](https://raw.githubusercontent.com/SamR1/python-twootfeed/master/images/MastodonRSSFeed.png) 
-
-Display on FreshRSS:  
-![Mastodon FreshRSS](https://raw.githubusercontent.com/SamR1/python-twootfeed/master/images/MastodonFreshRSS.png)  
-
-
-## Contribute
-see [Quick start for developers](https://github.com/SamR1/python-twootfeed/wiki/Quick-start-for-developers)
+➡️ see [documentation](https://samr1.github.io/python-twootfeed/index.html) for installation instructions and features.  
 
 
 ## Contributors

docs/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 9bb041ae8d48f10f011ae9f45d95b00f
+tags: 645f666f9bcd5a90fca523b33c5a78b7