diff --git a/manual/catalogs.rst b/manual/catalogs.rst index b473b0efb2..4840ade8bc 100644 --- a/manual/catalogs.rst +++ b/manual/catalogs.rst @@ -1,6 +1,3 @@ - -.. include:: global.rst - .. _catalog_tut: Creating AZW3 • EPUB • MOBI Catalogs diff --git a/manual/conf.py b/manual/conf.py index f30babc964..ea853e7f1f 100644 --- a/manual/conf.py +++ b/manual/conf.py @@ -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, diff --git a/manual/conversion.rst b/manual/conversion.rst index ad7440e99f..4aa12ce216 100644 --- a/manual/conversion.rst +++ b/manual/conversion.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _conversion: Ebook Conversion diff --git a/manual/creating_plugins.rst b/manual/creating_plugins.rst index c52b674162..a421b2a486 100644 --- a/manual/creating_plugins.rst +++ b/manual/creating_plugins.rst @@ -1,6 +1,3 @@ - -.. include:: global.rst - .. _pluginstutorial: Writing your own plugins to extend |app|'s functionality diff --git a/manual/custom.py b/manual/custom.py index e4e1f64ac9..a24466427e 100644 --- a/manual/custom.py +++ b/manual/custom.py @@ -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}`` diff --git a/manual/customize.rst b/manual/customize.rst index cfd63cea66..32ac609348 100644 --- a/manual/customize.rst +++ b/manual/customize.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. currentmodule:: calibre.customize.__init__ .. _customize: diff --git a/manual/db_api.rst b/manual/db_api.rst index 23a4d5dded..40ba1eca75 100644 --- a/manual/db_api.rst +++ b/manual/db_api.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _db_api: API Documentation for the database interface diff --git a/manual/develop.rst b/manual/develop.rst index dae7cb720c..650ff6e2f6 100644 --- a/manual/develop.rst +++ b/manual/develop.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _develop: Setting up a |app| development environment diff --git a/manual/diff.rst b/manual/diff.rst index 9fcaf64284..83157e8c97 100644 --- a/manual/diff.rst +++ b/manual/diff.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _diff: Comparing E-books diff --git a/manual/edit.rst b/manual/edit.rst index 033ffb7b6d..7f2395779e 100644 --- a/manual/edit.rst +++ b/manual/edit.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _edit: Editing E-books diff --git a/manual/faq.rst b/manual/faq.rst index 443c1ae48f..6a8cbf3082 100644 --- a/manual/faq.rst +++ b/manual/faq.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _faq: Frequently Asked Questions diff --git a/manual/global.rst b/manual/global.rst deleted file mode 100644 index f42b2548c6..0000000000 --- a/manual/global.rst +++ /dev/null @@ -1 +0,0 @@ -.. |app| replace:: calibre diff --git a/manual/glossary.rst b/manual/glossary.rst index 5fcfe5088c..987191d815 100755 --- a/manual/glossary.rst +++ b/manual/glossary.rst @@ -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 `_ for the syntax of regular expressions used in Python. + diff --git a/manual/gui.rst b/manual/gui.rst index a830832cd0..06c876fde8 100755 --- a/manual/gui.rst +++ b/manual/gui.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _gui: The Graphical User Interface diff --git a/manual/index.rst b/manual/index.rst index d856fe35fa..ef02dc3e6a 100755 --- a/manual/index.rst +++ b/manual/index.rst @@ -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 `. For even more power and versatility, learn the :ref:`Command Line Interface `. You will find the list of :ref:`Frequently Asked Questions ` useful as well. - -.. only:: online - - **An ebook version of this user manual is available in** `EPUB format `_, `AZW3 (Kindle Fire) format `_ and `PDF format `_. - -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/manual/metadata.rst b/manual/metadata.rst index bee9678f50..8836c297cb 100644 --- a/manual/metadata.rst +++ b/manual/metadata.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _metadata: Editing Ebook Metadata diff --git a/manual/news.rst b/manual/news.rst index 84b5a0c68a..f7cd322dcf 100755 --- a/manual/news.rst +++ b/manual/news.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _news: Adding your favorite news website diff --git a/manual/news_recipe.rst b/manual/news_recipe.rst index 767c47b41b..42088c3270 100644 --- a/manual/news_recipe.rst +++ b/manual/news_recipe.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _news_recipe: API Documentation for recipes diff --git a/manual/plugins.rst b/manual/plugins.rst index f430ebf791..125da552c8 100644 --- a/manual/plugins.rst +++ b/manual/plugins.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _plugins: API Documentation for plugins diff --git a/manual/polish.rst b/manual/polish.rst index 9537ceabda..fe184f691f 100644 --- a/manual/polish.rst +++ b/manual/polish.rst @@ -1,6 +1,3 @@ - -.. include:: global.rst - .. _polish_api: API Documentation for the ebook editing tools diff --git a/manual/regexp.rst b/manual/regexp.rst index be2faf25b3..48a9ba9562 100644 --- a/manual/regexp.rst +++ b/manual/regexp.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _regexptutorial: All about using regular expressions in |app| diff --git a/manual/server.rst b/manual/server.rst index f7b2be9cf6..52276330b6 100644 --- a/manual/server.rst +++ b/manual/server.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _servertutorial: Integrating the |app| content server into other servers diff --git a/manual/simple_index.rst b/manual/simple_index.rst new file mode 100644 index 0000000000..f36556ae8c --- /dev/null +++ b/manual/simple_index.rst @@ -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 `. For even more power and versatility, learn the :ref:`Command Line Interface `. You will find the list of :ref:`Frequently Asked Questions ` useful as well. + +.. only:: online + + **An ebook version of this user manual is available in** `EPUB format `_, `AZW3 (Kindle Fire) format `_ and `PDF format `_. + +Sections +------------ + +.. toctree:: + :maxdepth: 1 + + gui + news + viewer + conversion + edit + diff + metadata + faq + tutorials + customize + cli/cli-index + develop + glossary + + + diff --git a/manual/sub_groups.rst b/manual/sub_groups.rst index c08df9a901..95b3473bbc 100644 --- a/manual/sub_groups.rst +++ b/manual/sub_groups.rst @@ -1,6 +1,3 @@ - -.. include:: global.rst - .. _subgroups-tutorial: Managing subgroups of books, for example "genre" diff --git a/manual/template_lang.rst b/manual/template_lang.rst index 47e402693b..ceb0cbf532 100644 --- a/manual/template_lang.rst +++ b/manual/template_lang.rst @@ -1,6 +1,3 @@ - -.. include:: global.rst - .. _templatelangcalibre: The |app| template language diff --git a/manual/template_ref_generate.py b/manual/template_ref_generate.py index b331345572..af7a754a6b 100644 --- a/manual/template_ref_generate.py +++ b/manual/template_ref_generate.py @@ -7,8 +7,6 @@ __copyright__ = '2008, Kovid Goyal ' from collections import defaultdict PREAMBLE = '''\ -.. include:: global.rst - .. _templaterefcalibre: Reference for all built-in template language functions diff --git a/manual/tutorials.rst b/manual/tutorials.rst index 8668d3b594..4bd2a2c333 100755 --- a/manual/tutorials.rst +++ b/manual/tutorials.rst @@ -1,6 +1,3 @@ - -.. include:: global.rst - .. _tutorials: Tutorials diff --git a/manual/typesetting_math.rst b/manual/typesetting_math.rst index e631eaea10..5bc67175c9 100644 --- a/manual/typesetting_math.rst +++ b/manual/typesetting_math.rst @@ -1,6 +1,3 @@ - -.. include:: global.rst - .. _typesetting_math: diff --git a/manual/viewer.rst b/manual/viewer.rst index e41170514a..c2e78ffd07 100755 --- a/manual/viewer.rst +++ b/manual/viewer.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _viewer: The Ebook Viewer diff --git a/manual/virtual_libraries.rst b/manual/virtual_libraries.rst index 9432bb04ef..23d5a6e0e0 100644 --- a/manual/virtual_libraries.rst +++ b/manual/virtual_libraries.rst @@ -1,6 +1,3 @@ - -.. include:: global.rst - .. _virtual_libraries: diff --git a/manual/xpath.rst b/manual/xpath.rst index 79dfe5f41a..20d878ea63 100644 --- a/manual/xpath.rst +++ b/manual/xpath.rst @@ -1,5 +1,3 @@ -.. include:: global.rst - .. _xpath-tutorial: XPath Tutorial