mirror of
https://github.com/kovidgoyal/calibre.git
synced 2025-07-09 03:04:10 -04:00
Get rid of global.rst and REMOVE_IN_PDF
This commit is contained in:
Kovid Goyal
parent
44276ef20b
commit
6a0f24b281
@ -1,6 +1,3 @@
|
||||
|
||||
.. include:: global.rst
|
||||
|
||||
.. _catalog_tut:
|
||||
|
||||
Creating AZW3 • EPUB • MOBI Catalogs
|
||||
|
||||
@ -25,6 +25,8 @@ custom
|
||||
|
||||
needs_sphinx = '1.0'
|
||||
|
||||
rst_prolog = '.. |app| replace:: %s' % __appname__
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.addons.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc', 'custom', 'sphinx.ext.viewcode']
|
||||
@ -36,7 +38,9 @@ templates_path = ['templates']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
master_doc = 'index' if tags.has('online') else 'simple_index' # noqa
|
||||
# kill the warning about index/simple_index not being in a toctree
|
||||
exclude_patterns = ['simple_index.rst'] if master_doc == 'index' else ['index']
|
||||
|
||||
# The language
|
||||
language = 'en'
|
||||
@ -93,7 +97,7 @@ html_sidebars = {
|
||||
}
|
||||
|
||||
# The favicon
|
||||
html_favicon = 'favicon.ico'
|
||||
html_favicon = '../icons/favicon.ico'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the built-in static files,
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _conversion:
|
||||
|
||||
Ebook Conversion
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
|
||||
.. include:: global.rst
|
||||
|
||||
.. _pluginstutorial:
|
||||
|
||||
Writing your own plugins to extend |app|'s functionality
|
||||
|
||||
@ -20,8 +20,6 @@ def substitute(app, doctree):
|
||||
pass
|
||||
|
||||
CLI_INDEX='''
|
||||
.. include:: ../global.rst
|
||||
|
||||
.. _cli:
|
||||
|
||||
Command Line Interface
|
||||
@ -52,8 +50,6 @@ in a terminal.
|
||||
'''
|
||||
|
||||
CLI_PREAMBLE='''\
|
||||
.. include:: ../global.rst
|
||||
|
||||
.. _{cmd}:
|
||||
|
||||
``{cmd}``
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. currentmodule:: calibre.customize.__init__
|
||||
|
||||
.. _customize:
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _db_api:
|
||||
|
||||
API Documentation for the database interface
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _develop:
|
||||
|
||||
Setting up a |app| development environment
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _diff:
|
||||
|
||||
Comparing E-books
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _edit:
|
||||
|
||||
Editing E-books
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _faq:
|
||||
|
||||
Frequently Asked Questions
|
||||
|
||||
@ -1 +0,0 @@
|
||||
.. |app| replace:: calibre
|
||||
@ -1,4 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
Glossary
|
||||
==========
|
||||
@ -28,3 +27,4 @@ Glossary
|
||||
|
||||
regexp
|
||||
**Regular expressions** provide a concise and flexible means for identifying strings of text of interest, such as particular characters, words, or patterns of characters. See `regexp syntax <http://docs.python.org/lib/re-syntax.html>`_ for the syntax of regular expressions used in Python.
|
||||
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _gui:
|
||||
|
||||
The Graphical User Interface
|
||||
|
||||
@ -1,46 +1,4 @@
|
||||
.. include:: global.rst
|
||||
===============================================
|
||||
|app| User Manual
|
||||
===============================================
|
||||
|
||||
|app| is an ebook library manager. It can view, convert and catalog ebooks in most of the major ebook formats. It can also talk to many ebook reader devices. It can go out to the Internet and fetch metadata for your books. It can download newspapers and convert them into ebooks for convenient reading. It is cross platform, running on Linux, Windows and OS X.
|
||||
|
||||
You've just started |app|. What do you do now? Before |app| can do anything with your ebooks, it first has to know about them. Drag and drop a few ebook files into |app|, or click the "Add books" button and browse for the ebooks you want to work with. Once you've added the books, they will show up in the main view looking something like this:
|
||||
|
||||
.. image:: images/added_books.png
|
||||
|
||||
Once you've admired the list of books you just added to your heart's content, you'll probably want to read one. In order to do that you'll have to convert the book to a format your reader understands. When first running |app|, the Welcome Wizard starts and will set up calibre for your reader device. Conversion is a breeze. Just select the book you want to convert then click the "Convert books" button. Ignore all the options for now and click "OK". The little icon in the bottom right corner will start spinning. Once it's finished spinning, your converted book is ready. Click the "View" button to read the book.
|
||||
|
||||
If you want to read the book on your reader, connect it to the computer, wait till calibre detects it (10-20 seconds) and then click the "Send to device" button. Once the icon stops spinning again, disconnect your reader and read away! If you didn't convert the book in the previous step, |app| will auto convert it to the format your reader device understands.
|
||||
|
||||
To get started with more advanced usage, you should read about the :ref:`Graphical User Interface <gui>`. For even more power and versatility, learn the :ref:`Command Line Interface <cli>`. You will find the list of :ref:`Frequently Asked Questions <faq>` useful as well.
|
||||
|
||||
.. only:: online
|
||||
|
||||
**An ebook version of this user manual is available in** `EPUB format <calibre.epub>`_, `AZW3 (Kindle Fire) format <calibre.azw3>`_ and `PDF format <calibre.pdf>`_.
|
||||
|
||||
Sections
|
||||
------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
gui
|
||||
news
|
||||
viewer
|
||||
conversion
|
||||
edit
|
||||
diff
|
||||
metadata
|
||||
faq
|
||||
tutorials
|
||||
customize
|
||||
cli/cli-index
|
||||
develop
|
||||
glossary
|
||||
|
||||
|
||||
.. REMOVE_IN_PDF
|
||||
.. include:: simple_index.rst
|
||||
|
||||
The main |app| user interface
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _metadata:
|
||||
|
||||
Editing Ebook Metadata
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _news:
|
||||
|
||||
Adding your favorite news website
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _news_recipe:
|
||||
|
||||
API Documentation for recipes
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _plugins:
|
||||
|
||||
API Documentation for plugins
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
|
||||
.. include:: global.rst
|
||||
|
||||
.. _polish_api:
|
||||
|
||||
API Documentation for the ebook editing tools
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _regexptutorial:
|
||||
|
||||
All about using regular expressions in |app|
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _servertutorial:
|
||||
|
||||
Integrating the |app| content server into other servers
|
||||
|
||||
43
manual/simple_index.rst
Normal file
43
manual/simple_index.rst
Normal file
@ -0,0 +1,43 @@
|
||||
|
||||
===============================================
|
||||
|app| User Manual
|
||||
===============================================
|
||||
|
||||
|app| is an ebook library manager. It can view, convert and catalog ebooks in most of the major ebook formats. It can also talk to many ebook reader devices. It can go out to the Internet and fetch metadata for your books. It can download newspapers and convert them into ebooks for convenient reading. It is cross platform, running on Linux, Windows and OS X.
|
||||
|
||||
You've just started |app|. What do you do now? Before |app| can do anything with your ebooks, it first has to know about them. Drag and drop a few ebook files into |app|, or click the "Add books" button and browse for the ebooks you want to work with. Once you've added the books, they will show up in the main view looking something like this:
|
||||
|
||||
.. image:: images/added_books.png
|
||||
|
||||
Once you've admired the list of books you just added to your heart's content, you'll probably want to read one. In order to do that you'll have to convert the book to a format your reader understands. When first running |app|, the Welcome Wizard starts and will set up calibre for your reader device. Conversion is a breeze. Just select the book you want to convert then click the "Convert books" button. Ignore all the options for now and click "OK". The little icon in the bottom right corner will start spinning. Once it's finished spinning, your converted book is ready. Click the "View" button to read the book.
|
||||
|
||||
If you want to read the book on your reader, connect it to the computer, wait till calibre detects it (10-20 seconds) and then click the "Send to device" button. Once the icon stops spinning again, disconnect your reader and read away! If you didn't convert the book in the previous step, |app| will auto convert it to the format your reader device understands.
|
||||
|
||||
To get started with more advanced usage, you should read about the :ref:`Graphical User Interface <gui>`. For even more power and versatility, learn the :ref:`Command Line Interface <cli>`. You will find the list of :ref:`Frequently Asked Questions <faq>` useful as well.
|
||||
|
||||
.. only:: online
|
||||
|
||||
**An ebook version of this user manual is available in** `EPUB format <calibre.epub>`_, `AZW3 (Kindle Fire) format <calibre.azw3>`_ and `PDF format <calibre.pdf>`_.
|
||||
|
||||
Sections
|
||||
------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
gui
|
||||
news
|
||||
viewer
|
||||
conversion
|
||||
edit
|
||||
diff
|
||||
metadata
|
||||
faq
|
||||
tutorials
|
||||
customize
|
||||
cli/cli-index
|
||||
develop
|
||||
glossary
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
|
||||
.. include:: global.rst
|
||||
|
||||
.. _subgroups-tutorial:
|
||||
|
||||
Managing subgroups of books, for example "genre"
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
|
||||
.. include:: global.rst
|
||||
|
||||
.. _templatelangcalibre:
|
||||
|
||||
The |app| template language
|
||||
|
||||
@ -7,8 +7,6 @@ __copyright__ = '2008, Kovid Goyal <kovid at kovidgoyal.net>'
|
||||
from collections import defaultdict
|
||||
|
||||
PREAMBLE = '''\
|
||||
.. include:: global.rst
|
||||
|
||||
.. _templaterefcalibre:
|
||||
|
||||
Reference for all built-in template language functions
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
|
||||
.. include:: global.rst
|
||||
|
||||
.. _tutorials:
|
||||
|
||||
Tutorials
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
|
||||
.. include:: global.rst
|
||||
|
||||
.. _typesetting_math:
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _viewer:
|
||||
|
||||
The Ebook Viewer
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
|
||||
.. include:: global.rst
|
||||
|
||||
.. _virtual_libraries:
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. include:: global.rst
|
||||
|
||||
.. _xpath-tutorial:
|
||||
|
||||
XPath Tutorial
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user