From 7a737aa3a1d2829ac28df6cb4825f000cb9b8433 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Tue, 1 Jun 2010 19:01:25 -0600 Subject: [PATCH] Fix warnings when compiling user manual --- src/calibre/customize/__init__.py | 6 +----- src/calibre/manual/conversion.rst | 6 +++--- src/calibre/manual/faq.rst | 2 +- src/calibre/web/feeds/news.py | 6 +++--- 4 files changed, 8 insertions(+), 12 deletions(-) diff --git a/src/calibre/customize/__init__.py b/src/calibre/customize/__init__.py index 4eaaf3b90a..9a018231ef 100644 --- a/src/calibre/customize/__init__.py +++ b/src/calibre/customize/__init__.py @@ -29,7 +29,7 @@ class Plugin(object): ''' #: List of platforms this plugin works on - #: For example: ``['windows', 'osx', 'linux'] + #: For example: ``['windows', 'osx', 'linux']`` supported_platforms = [] #: The name of this plugin. You must set it something other @@ -214,10 +214,8 @@ class MetadataReaderPlugin(Plugin): Return metadata for the file represented by stream (a file like object that supports reading). Raise an exception when there is an error with the input data. - :param type: The type of file. Guaranteed to be one of the entries in :attr:`file_types`. - :return: A :class:`calibre.ebooks.metadata.MetaInformation` object ''' return None @@ -245,11 +243,9 @@ class MetadataWriterPlugin(Plugin): Set metadata for the file represented by stream (a file like object that supports reading). Raise an exception when there is an error with the input data. - :param type: The type of file. Guaranteed to be one of the entries in :attr:`file_types`. :param mi: A :class:`calibre.ebooks.metadata.MetaInformation` object - ''' pass diff --git a/src/calibre/manual/conversion.rst b/src/calibre/manual/conversion.rst index ee148c79c7..cd8abd0493 100644 --- a/src/calibre/manual/conversion.rst +++ b/src/calibre/manual/conversion.rst @@ -453,7 +453,7 @@ as HTML and then convert the resulting HTML file with |app|. When saving as HTML There is a Word macro package that can automate the conversion of Word documents using |app|. It also makes generating the Table of Contents much simpler. It is called BookCreator and is available for free -`here `_. +at `mobileread `_. Convert TXT documents ~~~~~~~~~~~~~~~~~~~~~~ @@ -493,7 +493,7 @@ TXT input supports a number of options to differentiate how paragraphs are detec allows for basic formatting to be added to TXT documents, such as bold, italics, section headings, tables, lists, a Table of Contents, etc. Marking chapter headings with a leading # and setting the chapter XPath detection expression to "//h:h1" is the easiest way to have a proper table of contents generated from a TXT document. - You can learn more about the markdown syntax `here `_. + You can learn more about the markdown syntax at `daringfireball `_. Convert PDF documents @@ -540,7 +540,7 @@ EPUB advanced formatting demo Various advanced formatting for EPUB files is demonstrated in this `demo file `_. The file was created from hand coded HTML using calibre and is meant to be used as a template for your own EPUB creation efforts. -The source HTML it was created from is available `here `_. The settings used to create the +The source HTML it was created from is available `demo.zip `_. The settings used to create the EPUB from the ZIP file are:: ebook-convert demo.zip .epub -vv --authors "Kovid Goyal" --language en --level1-toc '//*[@class="title"]' --disable-font-rescaling --page-breaks-before / --no-default-epub-cover diff --git a/src/calibre/manual/faq.rst b/src/calibre/manual/faq.rst index f7329fb54d..e606505194 100644 --- a/src/calibre/manual/faq.rst +++ b/src/calibre/manual/faq.rst @@ -133,7 +133,7 @@ Can I use the collections feature of the SONY reader? turned into a collection on the reader. Note that the PRS-500 does not support collections for books stored on the SD card. The PRS-505 does. How do I use |app| with my iPad/iPhone/iTouch? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can access your calibre library on a iPad/iPhone/iTouch over the air using the calibre content server. diff --git a/src/calibre/web/feeds/news.py b/src/calibre/web/feeds/news.py index 26b3ad0593..9faabb2615 100644 --- a/src/calibre/web/feeds/news.py +++ b/src/calibre/web/feeds/news.py @@ -146,7 +146,7 @@ class BasicNewsRecipe(Recipe): #: If True empty feeds are removed from the output. #: This option has no effect if parse_index is overriden in #: the sub class. It is meant only for recipes that return a list - #: of feeds using :member:`feeds` or :method:`get_feeds`. + #: of feeds using `feeds` or :method:`get_feeds`. remove_empty_feeds = False #: List of regular expressions that determines which links to follow @@ -256,7 +256,7 @@ class BasicNewsRecipe(Recipe): #: The CSS that is used to styles the templates, i.e., the navigation bars and #: the Tables of Contents. Rather than overriding this variable, you should - #: use :member:`extra_css` in your recipe to customize look and feel. + #: use `extra_css` in your recipe to customize look and feel. template_css = u''' .article_date { color: gray; font-family: monospace; @@ -506,7 +506,7 @@ class BasicNewsRecipe(Recipe): def get_obfuscated_article(self, url): ''' - If you set :member:`articles_are_obfuscated` this method is called with + If you set `articles_are_obfuscated` this method is called with every article URL. It should return the path to a file on the filesystem that contains the article HTML. That file is processed by the recursive HTML fetching engine, so it can contain links to pages/images on the web.