From 4ebf4d2e38750270c40dc1bfb9909a09ed98e25b Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sat, 3 May 2008 14:54:22 -0700 Subject: [PATCH] Moved to sphinx v0.2 for user manual --- src/calibre/manual/conf.py | 5 +- src/calibre/manual/faq.rst | 5 + src/calibre/manual/news_recipe.rst | 4 +- src/calibre/manual/templates/layout.html | 134 ----------------------- src/calibre/manual/templates/macros.html | 55 ---------- 5 files changed, 9 insertions(+), 194 deletions(-) delete mode 100644 src/calibre/manual/templates/layout.html delete mode 100644 src/calibre/manual/templates/macros.html diff --git a/src/calibre/manual/conf.py b/src/calibre/manual/conf.py index 1cad3adb4e..c0a70c5381 100644 --- a/src/calibre/manual/conf.py +++ b/src/calibre/manual/conf.py @@ -93,8 +93,9 @@ html_last_updated_fmt = '%b %d, %Y' # typographically correct entities. #html_use_smartypants = True -# Content template for the index page. -#html_index = '' +# Overall title of the documentation +html_title = 'calibre User Manual' +html_logo = 'resources/logo.png' # Custom sidebar templates, maps document names to template names. #html_sidebars = {} diff --git a/src/calibre/manual/faq.rst b/src/calibre/manual/faq.rst index 6036a0b8e7..d00d335eec 100644 --- a/src/calibre/manual/faq.rst +++ b/src/calibre/manual/faq.rst @@ -64,6 +64,11 @@ You should not use both |app| and Connect to transfer books to the reader. You c * Unplugging the reader and waiting till the list of books shows up again * Re-connecting the reader and starting the SONY software +Can I use the collections feature of the SONY reader? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +|app| has full support for collections. When you add tags to a book's metadata, those tags are turned into collections when you upload the book to the SONY reader. Also, the series information is automatically +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. + Library Management ------------------ diff --git a/src/calibre/manual/news_recipe.rst b/src/calibre/manual/news_recipe.rst index f0955c0dad..d486b7570b 100644 --- a/src/calibre/manual/news_recipe.rst +++ b/src/calibre/manual/news_recipe.rst @@ -126,9 +126,7 @@ CustomIndexRecipe .. class:: CustomIndexRecipe - This class is useful for getting content from websites that don't follow the "multiple articles in several feeds" content model. For example, it is used in the built-in recipe for fetching the `Daily Dilbert` comic strip. - - .. literalinclude:: ../web/feeds/recipes/dilbert.py + This class is useful for getting content from websites that don't follow the "multiple articles in several feeds" content model. .. automethod:: CustomIndexRecipe.custom_index diff --git a/src/calibre/manual/templates/layout.html b/src/calibre/manual/templates/layout.html deleted file mode 100644 index 8a1407b19b..0000000000 --- a/src/calibre/manual/templates/layout.html +++ /dev/null @@ -1,134 +0,0 @@ -{%- include "macros.html" %} -{%- block doctype -%} - -{%- endblock %} -{%- macro relbar %} -{# this macro needs to stay in layout.html due to it containing blocks #} -
-

Navigation

- -
-{%- endmacro %} - - - - {%- if builder != 'htmlhelp' %} - {%- set titlesuffix = " — " + project + " Documentation" %} - {%- endif %} - {{ title|striptags }}{{ titlesuffix }} - {%- if builder == 'web' %} - - {%- for link, type, title in page_links %} - - {%- endfor %} - {%- else %} - - - {%- endif %} - {%- if builder != 'htmlhelp' %} - - - - - {%- endif %} -{%- block rellinks %} - {%- if hasdoc('about') %} - - {%- endif %} - - - - {%- if hasdoc('copyright') %} - - {%- endif %} - - {%- if parents %} - - {%- endif %} - {%- if next %} - - {%- endif %} - {%- if prev %} - - {%- endif %} -{%- endblock %} -{%- block extrahead %}{% endblock %} - - - -{%- block beforerelbar %}{% endblock %} -{%- block relbar1 %}{{ relbar() }}{% endblock %} -{%- block afterrelbar %}{% endblock %} - -{%- block beforesidebar1 %}{% endblock %} -{%- block sidebar1 %}{# possible location for sidebar #}{% endblock %} -{%- block aftersidebar1 %}{% endblock %} - -{%- block beforedocument %}{% endblock %} -
-
- {%- if builder != 'htmlhelp' %} -
- {%- endif %} -
- {% block body %}{% endblock %} -
- {%- if builder != 'htmlhelp' %} -
- {%- endif %} -
-{%- block afterdocument %}{% endblock %} - -{%- block beforesidebar2 %}{% endblock %} -{%- block sidebar2 %}{{ sidebar() }}{% endblock %} -{%- block aftersidebar2 %}{% endblock %} -
-
- -{%- block relbar2 %}{{ relbar() }}{% endblock %} - -{%- block beforefooter %}{% endblock %} -{%- block footer %} -
- {%- if hasdoc('copyright') %} - © Copyright {{ copyright }}. - {%- else %} - © Copyright {{ copyright }}. - {%- endif %} - {%- if last_updated %} - Last updated on {{ last_updated }}. - {%- endif %} -
-{%- endblock %} -{%- block afterfooter %}{% endblock %} - - diff --git a/src/calibre/manual/templates/macros.html b/src/calibre/manual/templates/macros.html deleted file mode 100644 index 6997a7fb12..0000000000 --- a/src/calibre/manual/templates/macros.html +++ /dev/null @@ -1,55 +0,0 @@ -{%- macro sidebar %} - {%- if builder != 'htmlhelp' %} -
-
- {% if display_toc %} -

Table Of Contents

- {{ toc }} - {% endif %} - {%- if prev %} -

Previous topic

-

{{ prev.title }}

- {%- endif %} - {%- if next %} -

Next topic

-

{{ next.title }}

- {%- endif %} - {% if sourcename %} -

This Page

- - {% endif %} - {% if customsidebar %} - {{ rendertemplate(customsidebar) }} - {% endif %} - {% if current_page_name != "search" %} -

{{ builder == 'web' and 'Keyword' or 'Quick' }} search

-
- - - -
- {% if builder == 'web' %} -

Enter a module, class or function name.

- {% endif %} - {% endif %} -
- - - logo
{{ project }} - -
-
-
- {%- endif %} -{%- endmacro %} -