aboutsummaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorCédric Bonhomme <cedric@cedricbonhomme.org>2015-12-08 21:53:51 +0100
committerCédric Bonhomme <cedric@cedricbonhomme.org>2015-12-08 21:53:51 +0100
commit0821a0fc7c984411bdcc8d572b571184a1b09402 (patch)
tree2970dbbc5c75c2d8435db1d1e8072ceb71cbedb6 /documentation
parentUpdated README. (diff)
downloadnewspipe-0821a0fc7c984411bdcc8d572b571184a1b09402.tar.gz
newspipe-0821a0fc7c984411bdcc8d572b571184a1b09402.tar.bz2
newspipe-0821a0fc7c984411bdcc8d572b571184a1b09402.zip
A dedicated repository for the documentation has been created.
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Makefile153
-rw-r--r--documentation/conf.py242
-rw-r--r--documentation/deployment.rst132
-rw-r--r--documentation/index.rst33
-rw-r--r--documentation/internationalization.rst0
-rw-r--r--documentation/make.bat190
-rw-r--r--documentation/migrations.rst24
-rw-r--r--documentation/requirements.rst16
-rw-r--r--documentation/web-services.rst147
9 files changed, 0 insertions, 937 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
deleted file mode 100644
index 18130862..00000000
--- a/documentation/Makefile
+++ /dev/null
@@ -1,153 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest 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 " 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 " 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 " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in 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/pyAggr3g470r.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyAggr3g470r.qhc"
-
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/pyAggr3g470r"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyAggr3g470r"
- @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."
-
-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."
diff --git a/documentation/conf.py b/documentation/conf.py
deleted file mode 100644
index 9e41bed4..00000000
--- a/documentation/conf.py
+++ /dev/null
@@ -1,242 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# jarr documentation build configuration file, created by
-# sphinx-quickstart on Fri Feb 20 07:23:42 2015.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration -----------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'JARR (Just Another RSS Reader)'
-copyright = u'2015, Cédric Bonhomme'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '6.7'
-# The full version, including alpha/beta/rc tags.
-release = '6.7'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'alabaster'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'jarrdoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
- ('index', 'jarr.tex', u'jarr Documentation',
- u'Cédric Bonhomme', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', 'jarr', u'jarr Documentation',
- [u'Cédric Bonhomme'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output ------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', 'jarr', u'jarr Documentation',
- u'Cédric Bonhomme', 'jarr', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
diff --git a/documentation/deployment.rst b/documentation/deployment.rst
deleted file mode 100644
index f85c549c..00000000
--- a/documentation/deployment.rst
+++ /dev/null
@@ -1,132 +0,0 @@
-Deployment
-==========
-
-This application can be deployed on Heroku or on a traditional server.
-
-After installation, you will be able to connect with the email
-*root@jarr.localhost* and the password *password*.
-
-Deploying the application with Vagrant
---------------------------------------
-
-Installation of VirtualBox and Vagrant
-
-.. code-block:: bash
-
- $ sudo apt-get install virtualbox
- $ wget https://dl.bintray.com/mitchellh/vagrant/vagrant_1.7.4_x86_64.deb
- $ sudo dpkg -i vagrant_1.7.4_x86_64.deb
- $ rm vagrant_1.7.4_x86_64.deb
-
-Deployment of JARR
-
-.. code-block:: bash
-
- $ git clone https://github.com/JARR-aggregator/JARR.git
- $ cd JARR/vagrant/
- $ vagrant up
-
-Once the VM configured, go to the address http://127.0.0.1:5000.
-
-Deploying the application on Heroku
------------------------------------
-
-An instance of JARR is running `here <https://jarr.herokuapp.com>`_.
-
-The geek way
-''''''''''''
-
-.. code-block:: bash
-
- $ git clone https://github.com/JARR-aggregator/JARR.git
- $ cd JARR
- $ heroku create
- $ heroku addons:add heroku-postgresql:dev
- $ heroku config:set HEROKU=1
- $ git push heroku master
- $ heroku run init
- $ heroku ps:scale web=1
-
-To enable account creation for users, you have to set some environment
-variables:
-
-.. code-block:: bash
-
- $ heroku config:set SELF_REGISTRATION=1
- $ heroku config:set PLATFORM_URL=<URL-of-your-platform>
- $ heroku config:set RECAPTCHA_PUBLIC_KEY=<your-recaptcha-public-key>
- $ heroku config:set RECAPTCHA_PRIVATE_KEY=<your-recaptcha-private-key>
- $ heroku config:set NOTIFICATION_EMAIL=<notification-email>
- $ heroku config:set POSTMARK_API_KEY=<your-postmark-api-key>
- $ heroku addons:add postmark:10k
-
-`Postmark <https://postmarkapp.com/>`_ is used to send account confirmation links.
-
-If you don't want to open your platform just set *SELF_REGISTRATION* to 0.
-You will be still able to create accounts via the administration page.
-
-
-The simple way
-''''''''''''''
-
-Alternatively, you can deploy your own copy of the app using this button:
-
-.. image:: https://www.herokucdn.com/deploy/button.png
- :target: https://heroku.com/deploy?template=https://github.com/JARR-aggregator/JARR.git
-
-You will be prompted to choose an email and a password for the administrator's account.
-And some other optional environment variables, as previously presented.
-
-Deploying the application on a traditional server
--------------------------------------------------
-
-.. code-block:: bash
-
- $ git clone https://github.com/JARR-aggregator/JARR.git
- $ cd JARR/
-
-If you want to use PostgreSQL
-'''''''''''''''''''''''''''''
-.. code-block:: bash
-
- $ ./install.sh postgres
-
-If you want to use SQLite
-'''''''''''''''''''''''''
-
-.. code-block:: bash
-
- $ ./install.sh sqlite
-
-
-Finally:
-
-.. code-block:: bash
-
- $ python runserver.py
- * Running on http://0.0.0.0:5000/
- * Restarting with reloader
-
-
-Configuration
-=============
-
-Configuration (database url, email, proxy, user agent, etc.) is done via the
-file `conf/conf.cfg`.
-Check this file before initializing the database (with `manager.py`).
-
-If you want to use JARR with Tor/Privoxy, you just have to set the value
-of `http_proxy` (most of the time: `http_proxy = 127.0.0.1:8118`). Else leave
-the value blank.
-
-
-Automatic updates
-=================
-
-You can fetch new articles with `cron <https://en.wikipedia.org/wiki/Cron>`_.
-For example if you want to check for updates every 30 minutes, add this line to
-your cron rules (*crontab -e*):
-
-.. code-block:: bash
-
- */30 * * * * cd ~/.JARR/ ; python manager.py fetch_asyncio None None
diff --git a/documentation/index.rst b/documentation/index.rst
deleted file mode 100644
index 8f84c8a7..00000000
--- a/documentation/index.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-.. JARR documentation master file, created by
- sphinx-quickstart on Fri Feb 20 07:23:42 2015.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to JARR's documentation!
-========================================
-
-
-Configuration and deployment
-============================
-
-.. toctree::
- :maxdepth: 2
-
- requirements
- deployment
-
-Web services
-============
-
-.. toctree::
- :maxdepth: 2
-
- web-services
-
-Migrations
-==========
-
-.. toctree::
- :maxdepth: 2
-
- migrations
diff --git a/documentation/internationalization.rst b/documentation/internationalization.rst
deleted file mode 100644
index e69de29b..00000000
--- a/documentation/internationalization.rst
+++ /dev/null
diff --git a/documentation/make.bat b/documentation/make.bat
deleted file mode 100644
index fa0c6a48..00000000
--- a/documentation/make.bat
+++ /dev/null
@@ -1,190 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
- set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-set I18NSPHINXOPTS=%SPHINXOPTS% .
-if NOT "%PAPER%" == "" (
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
- set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
- :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. 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. text to make text files
- echo. man to make manual pages
- echo. texinfo to make Texinfo files
- echo. gettext to make PO message catalogs
- echo. changes to make an overview over all changed/added/deprecated items
- echo. linkcheck to check all external links for integrity
- echo. doctest to run all doctests embedded in the documentation if enabled
- goto end
-)
-
-if "%1" == "clean" (
- for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
- del /q /s %BUILDDIR%\*
- goto end
-)
-
-if "%1" == "html" (
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/html.
- goto end
-)
-
-if "%1" == "dirhtml" (
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
- goto end
-)
-
-if "%1" == "singlehtml" (
- %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
- goto end
-)
-
-if "%1" == "pickle" (
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can process the pickle files.
- goto end
-)
-
-if "%1" == "json" (
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can process the JSON files.
- goto end
-)
-
-if "%1" == "htmlhelp" (
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
- goto end
-)
-
-if "%1" == "qthelp" (
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyAggr3g470r.qhcp
- echo.To view the help file:
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyAggr3g470r.ghc
- goto end
-)
-
-if "%1" == "devhelp" (
- %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished.
- goto end
-)
-
-if "%1" == "epub" (
- %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The epub file is in %BUILDDIR%/epub.
- goto end
-)
-
-if "%1" == "latex" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
- goto end
-)
-
-if "%1" == "text" (
- %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The text files are in %BUILDDIR%/text.
- goto end
-)
-
-if "%1" == "man" (
- %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The manual pages are in %BUILDDIR%/man.
- goto end
-)
-
-if "%1" == "texinfo" (
- %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
- goto end
-)
-
-if "%1" == "gettext" (
- %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
- goto end
-)
-
-if "%1" == "changes" (
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
- if errorlevel 1 exit /b 1
- echo.
- echo.The overview file is in %BUILDDIR%/changes.
- goto end
-)
-
-if "%1" == "linkcheck" (
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
- if errorlevel 1 exit /b 1
- echo.
- echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
- goto end
-)
-
-if "%1" == "doctest" (
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
- if errorlevel 1 exit /b 1
- echo.
- echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
- goto end
-)
-
-:end
diff --git a/documentation/migrations.rst b/documentation/migrations.rst
deleted file mode 100644
index 97d2c0f9..00000000
--- a/documentation/migrations.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-Migrations
-==========
-
-Migrations of the database are managed
-with the database migrations tool
-`Alembic <https://bitbucket.org/zzzeek/alembic>`_.
-
-The Flask extensions `Flask-Script <https://github.com/smurfix/flask-script>`_
-and `Flask-Migrate <https://github.com/miguelgrinberg/flask-migrate/>`_
-are used to ease remote migrations.
-
-Local migrations
-----------------
-
-.. code-block:: bash
-
- $ python manager.py db upgrade
-
-Remote migrations
------------------
-
-.. code-block:: bash
-
- $ heroku run python manager.py db upgrade
diff --git a/documentation/requirements.rst b/documentation/requirements.rst
deleted file mode 100644
index a3630144..00000000
--- a/documentation/requirements.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-Requirements
-============
-
-The complete list of required Python modules is in the file
-``requirements.txt``.
-
-The core technologies used are:
-
-* `Flask <http://flask.pocoo.org>`_ for the web backend;
-* `asyncio <https://www.python.org/dev/peps/pep-3156/>`_ for the crawler;
-* `SQLAlchemy <http://www.sqlalchemy.org>`_ for the data base.
-
-Python 3.4 is highly recommended, especially for the feed crawler.
-The web server is working with Python 2.7 and Python 3.
-
-It is possible to connect your own crawler to the RESTful API.
diff --git a/documentation/web-services.rst b/documentation/web-services.rst
deleted file mode 100644
index 53035c3c..00000000
--- a/documentation/web-services.rst
+++ /dev/null
@@ -1,147 +0,0 @@
-Web service
-===========
-
-Articles
---------
-
-.. code-block:: python
-
- >>> import requests, json
- >>> r = requests.get("https://jarr.herokuapp.com/api/v2.0/article/1s",
- ... headers={'Content-type': 'application/json'},
- ... auth=("your-nickname", "your-password"))
- >>> r.status_code
- 200 # OK
- >>> rjson = r.json()
- >>> rjson["title"]
- 'Sponsors required for KDE code sprint in Randa'
- >>> rjson["date"]
- 'Wed, 18 Jun 2014 14:25:18 GMT'
- >>> r = requests.get("https://jarr.herokuapp.com/api/v2.0/article/1s",
- ... headers={'Content-type': 'application/json'},
- ... auth=("your-nickname", "your-password"),
- ... data=json.dumps({'id__in': [1, 2]}))
- >>> r.json()
- [{'id': 1, 'title': 'article1', [...]},
- {'id': 2, 'title': 'article2', [...]}]
-
-Add an article:
-
-.. code-block:: python
-
- >>> import requests, json
- >>> headers = {'Content-type': 'application/json', 'Accept': 'application/json'}
- >>> payload = {'link': 'http://blog.cedricbonhomme.org/2014/05/24/sortie-de-pyaggr3g470r-5-3/',
- ... 'title': 'Sortie de pyAggr3g470r 5.3',
- ... 'content':'La page principale de pyAggr3g470r a été améliorée...',
- ... 'date':'2014/06/23T11:42:20 GMT',
- ... 'feed_id':'42'}
- >>> r = requests.post("https://jarr.herokuapp.com/api/v2.0/article",
- ... headers=headers, auth=("your-nickname", "your-password"),
- ... data=json.dumps(payload))
- >>> r.status_code
- 201 # Created
- >>> # creating several articles at once
- >>> r = requests.post("https://jarr.herokuapp.com/api/v2.0/article",
- ... headers=headers, auth=("your-nickname", "your-password"),
- ... data=json.dumps([payload, payload]))
- >>> r.status_code
- 201 # Created
- >>> r.json()
- [123456, 234567]
- >>> r = requests.get("https://jarr.herokuapp.com/api/v2.0/articles",
- ... auth=("your-nickname", "your-password")
- ... data=json.dumps({'feed_id': 42, 'limit': 1}))
- >>> r.json()[0]["title"]
- "Sortie de pyAggr3g470r 5.3"
-
-Update an article:
-
-.. code-block:: python
-
- >>> import requests, json
- >>> r = requests.put("https://jarr.herokuapp.com/api/v2.0/article/65",
- ... headers={'Content-Type': 'application/json'},
- ... auth=("your-nickname", "your-password"),
- ... data=json.dumps({"like":True, "readed": False}))
- >>> r.status_code
- 200 # OK
- >>> r = requests.put("https://jarr.herokuapp.com/api/v2.0/articles",
- ... headers={'Content-Type': 'application/json'},
- ... auth=("your-nickname", "your-password"),
- ... data=json.dumps([[1, {"like": True, "readed": False}],
- ... [2, {"like": True, "readed": True}]]))
- >>> r.json()
- ['ok', 'ok']
-
-Delete one or several article(s):
-
-.. code-block:: python
-
- >>> import json, requests
- >>> r = requests.delete("https://jarr.herokuapp.com/api/v2.0/article/84574",
- ... headers={'Content-Type': 'application/json'},
- ... auth=("your-nickname", "your-password"))
- >>> r.status_code
- 204 # deleted - No content
- >>> r = requests.delete("https://jarr.herokuapp.com/api/v2.0/article/84574",
- ... headers={'Content-Type': 'application/json'},
- ... auth=("your-nickname", "your-password"))
- >>> r.status_code
- 404 # not found
- >>> r = requests.delete("https://jarr.herokuapp.com/api/v2.0/articles",
- ... headers={'Content-Type': 'application/json'},
- ... auth=("your-nickname", "your-password")
- ... data=json.dumps([84574]))
- >>> r.status_code
- 500 # already deleted
- >>> r = requests.delete("https://jarr.herokuapp.com/api/v2.0/articles",
- ... headers={'Content-Type': 'application/json'},
- ... auth=("your-nickname", "your-password")
- ... data=json.dumps([84575, 84576]))
- >>> r.status_code
- 204 # deleted - No content
- >>> r = requests.delete("https://jarr.herokuapp.com/api/v2.0/articles",
- ... headers={'Content-Type': 'application/json'},
- ... auth=("your-nickname", "your-password")
- ... data=json.dumps([84575, 84576, 84577]))
- >>> r.status_code
- 206 # partial - some deleted
- >>> r.json()
- ['404 - Not Found', '404 - Not Found', 'ok']
-
-
-Feeds
------
-
-Add a feed:
-
-.. code-block:: python
-
- >>> import json, requests
- >>> r = requests.post("https://jarr.herokuapp.com/api/v2.0/feeds",
- ... auth=("your-nickname", "your-password"),
- ... headers={'Content-Type': 'application/json'},
- ... data=json.dumps({'link': 'http://blog.cedricbonhomme.org/feed'}))
- >>> r.status_code
- 200
-
-Update a feed:
-
-.. code-block:: python
-
- >>> import json, requests
- >>> r = requests.put("https://jarr.herokuapp.com/api/v2.0/feeds/42",
- ... auth=("your-nickname", "your-password"),
- ... headers={'Content-Type': 'application/json'},
- ... data=json.dumps({"title":"Feed new title", "description":"New description"})
- >>> r.status_code
- 201
-
-Delete a feed:
-
-.. code-block:: python
-
- >>> import requests
- >>> r = requests.delete("https://jarr.herokuapp.com/api/v2.0/feeds/29",
- ... auth=("your-nickname", "your-password"))
bgstack15