Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-07-09 03:04:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix some warnings from sphinx

Browse Source
This commit is contained in:
Kovid Goyal 2019-07-12 05:52:29 +05:30
parent 36ff1b15b8
commit 44fe5e7793
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
manual/faq.rst
View File

@ -308,8 +308,8 @@ How do I use calibre with my iPad/iPhone/iPod touch?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The easiest way to transfer books wirelessly to your Apple device (iPad/iPhone/iPod) The easiest way to transfer books wirelessly to your Apple device (iPad/iPhone/iPod)
is to use the `Calibre Companion <https://calibrecompanion.co?utm_source=Calibre&utm_medium=Website&utm_campaign=Main&utm_term=FAQ&utm_content=IOS>`_ iOS app. is to use the `Calibre Companion <https://calibrecompanion.co?utm_source=Calibre&utm_medium=Website&utm_campaign=Main&utm_term=FAQ&utm_content=IOS>`__ iOS app.
This app allows calibre to connect to your Apple device wirelessly, just as though you This app allows calibre to connect to your Apple device wirelessly, just as though you
plugged in the device with a USB cable. You can browse files on the device plugged in the device with a USB cable. You can browse files on the device
in calibre and use the :guilabel:`Send to device` button to transfer files to in calibre and use the :guilabel:`Send to device` button to transfer files to
your device wirelessly. your device wirelessly.
@ -330,7 +330,7 @@ over the net. First perform the following steps in calibre
The Content server allows you to read books directly in Safari itself. In The Content server allows you to read books directly in Safari itself. In
addition, there are many apps for your iDevice that can connect to the calibre addition, there are many apps for your iDevice that can connect to the calibre
Content server. Examples include: Marvin, Mapleread and iBooks itself. Content server. Examples include: Marvin, Mapleread and iBooks itself.
Using the Content server Using the Content server
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -385,7 +385,7 @@ Over the air
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
The easiest way to transfer books wirelessly to your Android device is to use The easiest way to transfer books wirelessly to your Android device is to use
the `Calibre Companion <https://calibrecompanion.co?utm_source=Calibre&utm_medium=Website&utm_campaign=Main&utm_term=FAQ&utm_content=Android>`_ Android app. the `Calibre Companion <https://calibrecompanion.co?utm_source=Calibre&utm_medium=Website&utm_campaign=Main&utm_term=FAQ&utm_content=Android>`__ Android app.
This app allows calibre to connect to your Android device wirelessly, just as though you This app allows calibre to connect to your Android device wirelessly, just as though you
plugged in the device with a USB cable. You can browse files on the device plugged in the device with a USB cable. You can browse files on the device
in calibre and use the :guilabel:`Send to device` button to transfer files to in calibre and use the :guilabel:`Send to device` button to transfer files to
@ -412,11 +412,11 @@ You can now browse your book collection and download books from calibre
to your device to open with whatever e-book reading software you have on your to your device to open with whatever e-book reading software you have on your
android device. android device.
Calibre Companion and many reading apps support browsing the calibre library Calibre Companion and many reading apps support browsing the calibre library
directly. For example, in Aldiko, click My Catalogs, then + to add a catalog, directly. For example, in Aldiko, click My Catalogs, then + to add a catalog,
then give the catalog a title such as "calibre" and provide the URL listed then give the catalog a title such as "calibre" and provide the URL listed
above. You can now browse the calibre library and download directly into the above. You can now browse the calibre library and download directly into the
reading software. reading software.
Can I access my calibre books using the web browser in my Kindle or other reading device? Can I access my calibre books using the web browser in my Kindle or other reading device?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -689,7 +689,7 @@ then import it on another computer. First let's see how to export the data:
find out what the library folder is by clicking the calibre icon in the find out what the library folder is by clicking the calibre icon in the
toolbar. Choose the :guilabel:`Switch/create calibre library` action and toolbar. Choose the :guilabel:`Switch/create calibre library` action and
you will see the path to the current calibre library. you will see the path to the current calibre library.
Now on the new computer, start calibre for the first time. It will run the Now on the new computer, start calibre for the first time. It will run the
:guilabel:`Welcome wizard` asking you for the location of the calibre library. Point it :guilabel:`Welcome wizard` asking you for the location of the calibre library. Point it
to the previously copied folder. If the computer you are transferring to to the previously copied folder. If the computer you are transferring to

10
src/calibre/web/feeds/news.py
View File

@ -226,7 +226,7 @@ class BasicNewsRecipe(Recipe):
#: } #: }
#: #:
#: All keys are optional. For a full explanation of the search criteria, see #: All keys are optional. For a full explanation of the search criteria, see
#: `Beautiful Soup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/#searching-the-tree>`_ #: `Beautiful Soup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/#searching-the-tree>`__
#: A common example:: #: A common example::
#: #:
#: remove_tags = [dict(name='div', class_='advert')] #: remove_tags = [dict(name='div', class_='advert')]
@ -571,7 +571,7 @@ class BasicNewsRecipe(Recipe):
an ad page, return the HTML of the real page. Otherwise return an ad page, return the HTML of the real page. Otherwise return
None. None.
`soup`: A `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`_ `soup`: A `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`__
instance containing the downloaded :term:`HTML`. instance containing the downloaded :term:`HTML`.
''' '''
return None return None
@ -613,7 +613,7 @@ class BasicNewsRecipe(Recipe):
It can be used to do arbitrarily powerful pre-processing on the :term:`HTML`. It can be used to do arbitrarily powerful pre-processing on the :term:`HTML`.
It should return `soup` after processing it. It should return `soup` after processing it.
`soup`: A `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`_ `soup`: A `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`__
instance containing the downloaded :term:`HTML`. instance containing the downloaded :term:`HTML`.
''' '''
return soup return soup
@ -625,7 +625,7 @@ class BasicNewsRecipe(Recipe):
It can be used to do arbitrarily powerful post-processing on the :term:`HTML`. It can be used to do arbitrarily powerful post-processing on the :term:`HTML`.
It should return `soup` after processing it. It should return `soup` after processing it.
:param soup: A `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`_ instance containing the downloaded :term:`HTML`. :param soup: A `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`__ instance containing the downloaded :term:`HTML`.
:param first_fetch: True if this is the first page of an article. :param first_fetch: True if this is the first page of an article.
''' '''
@ -660,7 +660,7 @@ class BasicNewsRecipe(Recipe):
def index_to_soup(self, url_or_raw, raw=False, as_tree=False, save_raw=None): def index_to_soup(self, url_or_raw, raw=False, as_tree=False, save_raw=None):
''' '''
Convenience method that takes an URL to the index page and returns Convenience method that takes an URL to the index page and returns
a `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc>`_ a `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc>`__
of it. of it.
`url_or_raw`: Either a URL or the downloaded index page as a string `url_or_raw`: Either a URL or the downloaded index page as a string