diff options
| -rw-r--r-- | docs/Makefile | 153 | ||||
| -rw-r--r-- | docs/conf.py | 243 | ||||
| -rw-r--r-- | docs/index.rst | 267 | ||||
| -rw-r--r-- | docs/make.bat | 190 | ||||
| -rw-r--r-- | docs/schemas/Article | 29 | ||||
| -rw-r--r-- | docs/schemas/Feed | 28 |
6 files changed, 0 insertions, 910 deletions
diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 18130862..00000000 --- a/docs/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/docs/conf.py b/docs/conf.py deleted file mode 100644 index c7891a47..00000000 --- a/docs/conf.py +++ /dev/null @@ -1,243 +0,0 @@ -# -*- coding: utf-8 -*- -# -# pyAggr3g470r documentation build configuration file, created by -# sphinx-quickstart on Sat Sep 15 08:55:50 2012. -# -# 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'pyAggr3g470r' -copyright = u'2010-2013, 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 = '4.1' -# The full version, including alpha/beta/rc tags. -release = '4.1' - -# 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 = 'default' - -# 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 = 'pyAggr3g470rdoc' - - -# -- 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', 'pyAggr3g470r.tex', u'pyAggr3g470r 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', 'pyaggr3g470r', u'pyAggr3g470r 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', 'pyAggr3g470r', u'pyAggr3g470r Documentation', - u'Cédric Bonhomme', 'pyAggr3g470r', '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/docs/index.rst b/docs/index.rst deleted file mode 100644 index 9eaad962..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,267 +0,0 @@ -.. pyAggr3g470r documentation master file, created by - sphinx-quickstart on Sat Sep 15 08:55:50 2012. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. toctree:: - :maxdepth: 2 - - -Presentation ------------- - -pyAggr3g470r_ is a news aggregator with a web interface -based on CherryPy_. Articles are stored in a MongoDB_ base. - -* `Ohloh page <http://www.ohloh.net/p/pyAggr3g470r>`_ of pyAggr3g470r; -* `Freecode page <http://freecode.com/projects/pyaggr3g470r>`_ of pyAggr3g470r. - - -Features --------- - -* articles are stored in a MongoDB_ database (local or remote); -* HTTP proxy support; -* fast full-text indexing and searching thanks the Whoosh_ library; -* e-mail notification; -* export articles to HTML, EPUB, PDF or raw text; -* favorite articles; -* language detection; -* sharing with Diaspora, Google Buzz, Pinboard, Identi.ca, Digg, reddit, Scoopeo, Blogmarks and Twitter; -* generation of QR codes with URLs of articles. - - -Installation ------------- -Requierements -~~~~~~~~~~~~~ -Software required -````````````````` - -* Python_ >= 3.1; -* MongoDB_ and PyMongo_ >= 1.9; -* Whoosh_ (article searching); -* feedparser_ >= 5.1.2 (for **feedgetter.py**, the RSS feed parser); -* CherryPy_ >= 3.2.4 and Mako_ (for **pyAggr3g470r.py**, the Web interface); -* BeautifulSoup_ bs4 >= 4.1.2 (automatically find a feed in a HTML page). - -Python 3.3 is recommended (better performances with large collections). - -Optional module -``````````````` - -These modules are not required but enables more features: - -* guess_language_ and PyEnchant_ for the language detection; -* lxml and Genshi for the generation of EPUB; -* Pillow (friendly fork of Python Imaging Library) for the generation of QR codes. - - -Script of installation -~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: bash - - # Installation of Python - wget http://www.python.org/ftp/python/3.3.1/Python-3.3.1.tar.bz2 - tar -xvjf Python-3.3.1.tar.bz2 - rm Python-3.3.1.tar.bz2 - cd Python-3.3.1/ - ./configure - make - sudo make install - cd .. - sudo rm -Rf Python-3.3.1/ - # Installation of Distribute and PIP - wget https://pypi.python.org/packages/source/d/distribute/distribute-0.6.36.tar.gz - tar -xzvf distribute-0.6.36.tar.gz - rm distribute-0.6.36.tar.gz - cd distribute-0.6.36/ - sudo python3.3 setup.py install - cd .. - sudo rm -Rf distribute-0.6.36/ - wget https://github.com/pypa/pip/archive/develop.tar.gz -O pip-develop.tar.gz - tar -xzvf pip-develop.tar.gz - rm pip-develop.tar.gz - cd pip-develop/ - sudo python3.3 setup.py install - cd .. - sudo rm -Rf pip-develop/ - # Core requirements for pyAggr3g470r - sudo pip-3.3 install whoosh - sudo pip-3.3 install feedparser - sudo pip-3.3 install beautifulsoup4 - sudo pip-3.3 install mako - sudo pip-3.3 install pymongo - # CherryPy, Minimalist Python Web Framework: - wget https://bitbucket.org/cherrypy/cherrypy/get/3.2.4.tar.gz - tar -xzvf 3.2.4.tar.gz - rm 3.2.4.tar.gz - cd cherrypy-cherrypy-cd8acbc5f2b3/ - sudo python3.3 setup.py install - cd .. - sudo rm -Rf cherrypy-cherrypy-cd8acbc5f2b3/ - # Language detection: - hg clone https://bitbucket.org/spirit/guess_language/ - cd guess_language/ - sudo python3.3 setup.py install - cd .. - sudo rm -Rf guess_language/ - # PyEnchant, for the language detection - sudo pip-3.3 install pyenchant - # Pillow, for the generation of QR Code - sudo pip-3.3 install pillow - # Finally, download pyAggr3g470r - hg clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r - cd pyaggr3g470r/source/ - cp cfg/pyAggr3g470r.cfg-sample cfg/pyAggr3g470r.cfg - exit 0 - - -Setting -~~~~~~~ - -List of feeds -````````````` - -Rename the file **./cfg/pyAggr3g470r.cfg-sample** to **./cfg/pyAggr3g470r.cfg**. -By default you don't have to edit this file (only in order to configure mail notification). - -Then, indicate the feeds to retrieve in the file **./var/feed.lst**. One feed per line. For example : - -.. code-block:: cfg - - http://blog.cedricbonhomme.org/feed/ - http://linuxfr.org/backend/news-homepage/rss20.rss - http://rss.slashdot.org/Slashdot/slashdot - http://theinvisiblethings.blogspot.com/feeds/posts/default - http://torvalds-family.blogspot.com/feeds/posts/default - http://www.python.org/channews.rdf - http://www.kde.org/dotkdeorg.rdf - http://feeds.feedburner.com/internetactu/bcmJ - http://www.april.org/fr/rss.xml - http://www.framablog.org/index.php/feed/atom - http://formats-ouverts.org/rss.php - http://lwn.net/headlines/newrss - http://kernelnewbies.org/RecentChanges?action=rss_rc&ddiffs=1&unique=1 - - -Create a new user -````````````````` -The default username is *admin* with the password *admin*. You can change the username and password -via the management page. Passwords are hashed and stored in the file **./var/password**. - -Mail notification -````````````````` -If you wish to stay tuned from new articles of a feed by email, you have to edit the the **mail** -section of the configuration file: - -* set the value of *enabled* to 1; -* set the *mail_to* value, your e-mail address (address of the recipient of the news); -* set the *smtp* value, the address of the SMTP server, and; -* set the *username* and *password* values for the authentication to the SMTP server. - -.. code-block:: ini - - [MongoDB] - address = 127.0.0.1 - port = 27017 - dbname = bob_pyaggr3g470r - user = bob - password = - [feedparser] - http_proxy = 127.0.0.1:8118 - user_agent = pyAggr3g470r (https://bitbucket.org/cedricbonhomme/pyaggr3g470r) - feed_list = ./var/feed.lst - [mail] - enabled = 0 - mail_from = pyAggr3g470r@no-reply.com - mail_to = address_of_the_recipient@example.com - smtp = smtp.example.com - username = your_mail_address@example.com - password = your_password - [misc] - diaspora_pod = joindiaspora.com - -Then just click on "Stay tuned" for the desired feed(s) at the main page of pyAggr3g470r in your browser. - -HTTP proxy -`````````` -You can specify the address of a proxy in the configuration file (in the *feedparser* section). -For example `127.0.0.1:8118`, if you are using Privoxy/Tor. If you are not using a proxy just -leave the value of `http_proxy` to blank. - - -Launch ------- -To launch pyAggr3g470r: - -.. code-block:: bash - - $ cd ~/pyaggr3g470r/source/ - $ pyAggr3g470r start - - - -Backup ------- -If you want to backup your database: - -.. code-block:: bash - - $ su - $ /etc/init.d/mongodb stop - $ cp /var/lib/mongodb/pyaggr3g470r.* ~ - -Alternatively you can use **mongodump**: - - $ mongodump --db pyaggr3g470r - -And **mongorestore** to restore the database: - - $ mongorestore --db pyaggr3g470r dump/pyaggr3g470r/ - -**mongorestore** only performs inserts into the existing database. - -Demo ----- -* some `screen shots <https://plus.google.com/u/0/photos/106973022319954455496/albums/5449733578800221153>`_ of **pyAggr3g470r**; -* an old `video <http://youtu.be/Eyxpqn9Rpnw>`_ of pyAggr3g470r; -* an example of `HTML auto-generated archive <http://log.cedricbonhomme.org/>`_. - - - -Donation --------- -If you wish and if you like pyAggr3g470r, you can donate via bitcoin. - -My bitcoin address: 1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ - -Thank you! - - - -License -------- -pyAggr3g470r_ is under GPLv3_ license. - - - -Contact -------- -`My home page <http://cedricbonhomme.org/>`_. - - - -.. _Python: http://python.org/ -.. _pyAggr3g470r: https://bitbucket.org/cedricbonhomme/pyaggr3g470r/ -.. _feedparser: http://feedparser.org/ -.. _MongoDB: http://www.mongodb.org/ -.. _Whoosh: https://bitbucket.org/mchaput/whoosh -.. _PyMongo: https://github.com/mongodb/mongo-python-driver -.. _CherryPy: http://cherrypy.org/ -.. _Mako: http://www.makotemplates.org/ -.. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/ -.. _guess_language: https://bitbucket.org/spirit/guess_language/ -.. _PyEnchant: http://pypi.python.org/pypi/pyenchant -.. _GPLv3: http://www.gnu.org/licenses/gpl-3.0.txt diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index fa0c6a48..00000000 --- a/docs/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/docs/schemas/Article b/docs/schemas/Article deleted file mode 100644 index 45acd3e8..00000000 --- a/docs/schemas/Article +++ /dev/null @@ -1,29 +0,0 @@ -.. -*-restructuredtext-*- - - -Schema for a Article object -=========================== - - { - article_id: (str), - type: (int), - article_date: (datetime), - article_link: (str), - article_title: (str), - article_content: (str), - article_readed: (bool), - article_like: (bool) - } - - -Schema description -================== - -* article_id: the id of the article in hexadecimal digits (SHA1 hash of the article's URL); -* type: equal to 1 for an article and to 0 for a feed; -* article_date: the date of publication of the article; -* article_link: the URL of the article; -* article_title: the title of the article; -* article_content: the content (description) of the article; -* article_readed: set to True if the article is read, else False; -* article_like: set to True for liked article, else False.
\ No newline at end of file diff --git a/docs/schemas/Feed b/docs/schemas/Feed deleted file mode 100644 index cff37610..00000000 --- a/docs/schemas/Feed +++ /dev/null @@ -1,28 +0,0 @@ -.. -*-restructuredtext-*- - - -Schema for a Feed object -======================== - - { - feed_id: (str), - type: (int), - feed_image: (str), - feed_title: (str), - feed_link: (str), - site_link: (str), - mail: (bool) - } - - -Schema description -================== - - -* feed_id: the id of the feed in hexadecimal digits (SHA1 hash of the feed's URL); -* type: equal to 1 for an article and to 0 for a feed; -* feed_image: URL of the favicon of the feed; -* feed_title: title of the feed; -* feed_link: URL of the feed; -* site_link: URL of the site; -* mail: set to True if sibscribed to the feed, else False.
\ No newline at end of file |